openapi: 3.0.0 info: title: Yext API version: '2.0' servers: - url: https://api.yextapis.com/v2 paths: /accounts/{accountId}/entities: get: operationId: listEntities parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"name":{"$eq":"John"}}`, then the filter param after URL-encoding will be: `filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D` **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "name":{ "$eq":"John" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `name` is the *field* being filtered by, and `John` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "firstName":{ "$eq":"John" } }, { "countryCode":{ "$in":[ "US", "GB" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "name": { "$eq": "John" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "name":{ "!$eq":"John" } } ``` **Filter Complement** You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something. ``` { "$complement":{ "description":{ "$contains":"hello" } } } ``` **Addressing Subfields** Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**: ``` { "c_myCustomField":{ "age": 30, "name": "Jim", } } ``` While filtering, subfields may be addressed using the "dot" notation. ``` { "c_myCustomField.name":{ "!$eq":"John" } } ``` Fields that are nested deeper may be addressed using dot notation, as well. For example, if **`name`** in the above example was a compound field with two subfields **`first`** and **`last`**, **`first`** may be addressed as **`c_myCustomField.name.first`**. **Field Support** Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field **`name`** supports the `TEXT` filter type, which supports `$eq` (equals) and `$startsWith` (starts with). **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)
Matcher Details
$eq (equals) { "countryCode":{ "$eq":"US" } }, { "countryCode":{ "!$eq":"US" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "Amazing" starts with "amaz" { "address.line1":{ "$startsWith": "Jo" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "firstName":{ "$in": ["John", "Jimmy"] } } Does not support negation. Negation can be mimicked by using an "OR" matcher, for example: { "$and":[ { "firstName":{ "!$eq": "John" } }, { "firstName":{ "!$eq": "Jimmy" } } ] }
$contains { "c_myString":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myString`**. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myString":{ "$containsAny":[ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myString":{ "$containsAll":[ "sample1", "sample2" ] } } This filter will match if both "sample1" and "sample2" are contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
Matcher Details
$eq { "isFreeEvent": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**STRUCT** The STRUCT filter type is supported for compound fields with subfields. *e.g., **`address`**, **`featuredMessage`**, fields of custom types*
Matcher Details
$hasProperty Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set. { "address": { "$hasProperty": "line1" } } Note that if a given property of a compound field is not set, the filter will not match. For example, if `line1` of **`address`** is not set for an entity, then the above matcher will not match the entity. Supports negation.
**OPTION** The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*
Matcher Details
$eq Matching is case insensitive and insensitive to consecutive whitespace. e.g., "XYZ 123" matches "xyz 123" { "eventStatus": { "$eq": "SCHEDULED" } } Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.
$in { "eventStatus": { "$in": [ "SCHEDULED", "POSTPONED" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example: { "$and": [ { "eventStatus":{ "!$eq": "SCHEDULED" } }, { "firstName":{ "!$eq": "POSTPONED" } } ] }
**PHONE** The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for `$eq`, the same phone number with or without calling code will match.
Matcher Details
$eq { "mainPhone":{ "$eq":"+18187076189" } }, { "mainPhone":{ "$eq":"8187076189" } }, { "mainPhone":{ "!$eq":"9177076189" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "8187076189" starts with "818" { "mainPhone":{ "$startsWith": "818" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "mainPhone":{ "$in": [ "8185551616", "9171112211" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "ageRange.maxValue": { "$eq": "80" } } Supports negation.
$lt Less than { "time.start": { "$lt": "2018-08-28T05:56" } }
$gt Greater than { "ageRange.maxValue": { "$gt": "50" } }
$le Less than or equal to { "ageRange.maxValue": { "$le": "40" } }
$ge Greater than or equal to { "time.end": { "$ge": "2018-08-28T05:56" } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "ageRange.maxValue : { "$gt" : 10, "$lt": 20 } }
**LIST OF TEXT** Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.
Matcher Details
$eq { "c_myStringList": { "$eq": "sample" } } This filter will match if "sample" EXACTLY matches any string within **`c_myStringList`**. Supports negation.
$eqAny { "c_myStringList": { "$eqAny": [ "sample1", "sample2" ] } } This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within **`c_myStringList`** . The argument can have more than two strings. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "sample1" AND "sample2" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings. Supports negation.
$contains { "c_myStringList":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myStringList`**. Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myStringList": { "$containsAny": [ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAny` is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myStringList": { "$containsAll": [ "sample1", "sample2" ] } } This filter will match if BOTH "sample1" and "sample2" are contained in strings within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAll` is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$startsWith { "c_myStringList": { "$startsWith":"sample" } } This filter will match if any string within **`c_myStringList`** starts with "sample". Does not supports negation. Case Insensitive.
**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**
Matcher Details
$eq { "c_myDateList": { "$eq": "2019-01-01" } } This filter will match if "2019-01-01" EXACTLY matches any date within **`c_myDateList`**. Supports negation.
$eqAny { "c_myIntegerList": { "$eqAny": [1, 2] } } This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within **`c_myDateList`**. The argument list can have more than two elements. Supports negation.
**LIST OF STRUCT** Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if **`c_myStructList`** is a list of compound fields with the subfields **`age`** and **`name`**, then one can address the **`age`** properties of each field in **`c_myStructList`** as a flattened list of integers and filtering upon them. For example, the following filter: ``` { "c_myStructList.age":{ "$eq": 20 } } ``` will match if any field in the list has an **`age`** property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to **`age`** in this case (`$eq`, `$eqAll`, `$eqAny`). **HOURS** By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Matcher Details
$openAt { "hours": { "$openAt": "2019-01-06T13:45" } } This filter would match entities open at the specified time.
$closedAt { "hours": { "$closedAt: "2019-01-06T13:45" } }
$openForAllOf { "hours": { "$openForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00. { "hours": { "$openForAllOf": "2019-05-10" } } This filter would match entities open for the entire 24 hour period on 2019-05-10. You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.
$openForAnyOf { "hours": { "$openForAnyOf": { "start": "now", "end": "now+2h" } } } This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.
$closedForAllOf { "hours": { "$closedForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match only those entities that are closed for the entire given time range.
$closedForAnyOf { "hours": { "$closedForAnyOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match any entities that are closed for at least a portion of the given time range.
**Filtering by Dates and Times** **Time zones** The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`. To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: `2019-06-07T15:30[America/New_York]` or `2019-06-06[America/Phoenix]`. **Date and time types** In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter: ``` { "time.start": { "$eq": "2018" } } ``` would match all start times in the year 2018. The same logic would apply for a month (`2019-05`), a date (`2019-05-01`), or an hour (`2019-05-01T06`). These types also work with ordered searches. For example: ``` { "time.start": { "$lt": "2018" } } ``` would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a `$le` matcher would include anything in or before 2018. **"Now" and Date Math** Instead of providing a static date or time, you can also use `now` in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search. In order to search for a future or past time relative to `now`, you can use date math. For example, you can enter `now+3h` or `now-1d`, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (`m`), months (`M`), and years (`y`). It is also possible to add or subtract time from a static date or datetime. Simply add `||` between the static value and any addition or subtraction. For example, `2019-02-03||+1d` would be the same as `2019-02-04`. You can also convert date and time types to other types. For example, to convert the datetime `2019-05-06T22:15` to a date, use `2019-05-06T22:15||/d`. Doing so would yield the same result as using `2019-05-06`. This method also works with `now`: `now/d` will give you today’s date without the time. **Filtering Across an Entity** It is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.
Matcher Details
$anywhere Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists) { "$anywhere": "hello" } This filter will match all entities that contain the string "hello" or strings that begin with "hello".
**Examples** The following filter will match against entities that: - Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter) - Have a name that starts with the text "Century" - Have a maximum age between 10 and 20 - Have a minimum age between 5 and 7 - Start after 7 PM (19:00) on August 28, 2018 ``` { "$and":[ { "entityType":{ "$eq":"event" } }, { "name":{ "$startsWith":"Century" } }, { "ageRange.maxValue":{ "$gt":10, "$lt":20 } }, { "ageRange.minValue":{ "$gt":5, "$lt":7 } }, { "time.start":{ "$ge":"2018-08-28T19:00" } } ] } ``` name: filter in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of language codes. When present, the system will return Entities that have profiles in one or more of the provided languages. For each Location, only the first available profile from the provided list of languages will be returned. The keyword `"primary"` can be used to refer to a Location’s primary profile without providing a specific language code. If an Entity does not have profiles in any of the languages provided, that Entity's primary profile will be returned. name: languages in: query required: false - schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. name: limit in: query required: false - schema: multipleOf: 1 type: number default: '0' description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. name: offset in: query required: false - schema: minLength: 0 type: string description: If a response to a previous request contained the **`pageToken`** field, pass that field's value as the **`pageToken`** parameter to retrieve the next page of data. name: pageToken in: query required: false - schema: 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" 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` pageToken: minLength: 0 type: string description: | Pass this value into the next request as the **`pageToken`** parameter to retrieve the next page of data. If the response of a request contains the last page of data, a **`pageToken`** value will not be returned. A **`pageToken`** will never appear in the response if the request contains the **`sortOrder`**, **`randomization`**, or **`randomizationToken`** parameters. headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} 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: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. 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**." Valid values: * `markdown` * `html` 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: 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. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - 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" 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} 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**." Valid values: * `markdown` * `html` 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: 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. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve name: languageCodes in: query required: false - 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entityprofiles: get: operationId: listAllLanguageProfiles parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: | Comma-separated list of Entity types to filter on. Example: `"location,event"` Should be from the following types: * `atm` * `event` * `faq` * `financialProfessional` * `healthcareFacility` * `healthcareProfessional` * `hotel` * `hotelRoomType` * `job` * `location` * `organization` * `product` * `restaurant` OR the API name of a custom entity type. name: entityTypes in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"name":{"$eq":"John"}}`, then the filter param after URL-encoding will be: `filter=%7B%22name%22%3A%7B%22%24eq%22%3A%22John%22%7D%7D` **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "name":{ "$eq":"John" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `name` is the *field* being filtered by, and `John` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "firstName":{ "$eq":"John" } }, { "countryCode":{ "$in":[ "US", "GB" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "name": { "$eq": "John" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "name":{ "!$eq":"John" } } ``` **Filter Complement** You can also search for the complement of a filter. This filter would match entities that do not contain "hello" in their descriptions, or do not have a description set. This is different from negation which can only match entities who have the negated field set to something. ``` { "$complement":{ "description":{ "$contains":"hello" } } } ``` **Addressing Subfields** Subfields of fields can be addressed using the "dot" notation while filtering. For example, if you have a custom field called **`c_myCustomField`**: ``` { "c_myCustomField":{ "age": 30, "name": "Jim", } } ``` While filtering, subfields may be addressed using the "dot" notation. ``` { "c_myCustomField.name":{ "!$eq":"John" } } ``` Fields that are nested deeper may be addressed using dot notation, as well. For example, if **`name`** in the above example was a compound field with two subfields **`first`** and **`last`**, **`first`** may be addressed as **`c_myCustomField.name.first`**. **Field Support** Entity fields correspond to certain filter types, which support matchers. Going by the example above, the field **`name`** supports the `TEXT` filter type, which supports `$eq` (equals) and `$startsWith` (starts with). **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`name`**, **`countryCode`**)
Matcher Details
$eq (equals) { "countryCode":{ "$eq":"US" } }, { "countryCode":{ "!$eq":"US" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "Amazing" starts with "amaz" { "address.line1":{ "$startsWith": "Jo" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "firstName":{ "$in": ["John", "Jimmy"] } } Does not support negation. Negation can be mimicked by using an "OR" matcher, for example: { "$and":[ { "firstName":{ "!$eq": "John" } }, { "firstName":{ "!$eq": "Jimmy" } } ] }
$contains { "c_myString":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myString`**. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myString":{ "$containsAny":[ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myString":{ "$containsAll":[ "sample1", "sample2" ] } } This filter will match if both "sample1" and "sample2" are contained in any string within **`c_myString`**. The argument list can contain more than two strings. Note that this matching is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No custom fields.
Matcher Details
$eq { "isFreeEvent": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**STRUCT** The STRUCT filter type is supported for compound fields with subfields. *e.g., **`address`**, **`featuredMessage`**, fields of custom types*
Matcher Details
$hasProperty Matches if argument is a key (subfield) of field being filtered by. This filter type is useful for filtering by compound fields or to check if certain fields have a value set. { "address": { "$hasProperty": "line1" } } Note that if a given property of a compound field is not set, the filter will not match. For example, if `line1` of **`address`** is not set for an entity, then the above matcher will not match the entity. Supports negation.
**OPTION** The OPTION filter type is supported for options custom fields and fields that have a predetermined list of valid values. *e.g., **`eventStatus`**, **`gender`**, `SINGLE_OPTION` and `MULTI_OPTION` types of custom fields.*
Matcher Details
$eq Matching is case insensitive and insensitive to consecutive whitespace. e.g., "XYZ 123" matches "xyz 123" { "eventStatus": { "$eq": "SCHEDULED" } } Supports negation. Negating `$eq` on the list will match any field that does not hold any of the provided values.
$in { "eventStatus": { "$in": [ "SCHEDULED", "POSTPONED" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values. For example: { "$and": [ { "eventStatus":{ "!$eq": "SCHEDULED" } }, { "firstName":{ "!$eq": "POSTPONED" } } ] }
**PHONE** The PHONE filter type is supported for phone number fields only. PHONE will support the same matchers as TEXT, except that for `$eq`, the same phone number with or without calling code will match.
Matcher Details
$eq { "mainPhone":{ "$eq":"+18187076189" } }, { "mainPhone":{ "$eq":"8187076189" } }, { "mainPhone":{ "!$eq":"9177076189" } } Supports negation. Case insensitive.
$startsWith Matches if the field starts with the argument value. e.g., "8187076189" starts with "818" { "mainPhone":{ "$startsWith": "818" } } Supports negation. Case insensitive.
$in Matches if field value is a member of the argument list. { "mainPhone":{ "$in": [ "8185551616", "9171112211" ] } } Does not support negation. However, negation can be mimicked by using an `$and` matcher to negate individually over the desired values.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "ageRange.maxValue": { "$eq": "80" } } Supports negation.
$lt Less than { "time.start": { "$lt": "2018-08-28T05:56" } }
$gt Greater than { "ageRange.maxValue": { "$gt": "50" } }
$le Less than or equal to { "ageRange.maxValue": { "$le": "40" } }
$ge Greater than or equal to { "time.end": { "$ge": "2018-08-28T05:56" } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "ageRange.maxValue : { "$gt" : 10, "$lt": 20 } }
**LIST OF TEXT** Any field that has a list of valid values and supports any of the previously mentioned filter types will also support the `$contains` matcher.
Matcher Details
$eq { "c_myStringList": { "$eq": "sample" } } This filter will match if "sample" EXACTLY matches any string within **`c_myStringList`**. Supports negation.
$eqAny { "c_myStringList": { "$eqAny": [ "sample1", "sample2" ] } } This filter will match if any one of "sample1" or "sample2" EXACTLY match a string within **`c_myStringList`** . The argument can have more than two strings. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "sample1" AND "sample2" EXACTLY match a string within **`c_myStringList`**. The argument can have more than two strings. Supports negation.
$contains { "c_myStringList":{ "$contains":"sample" } } This filter will match if "sample" is contained in any string within **`c_myStringList`**. Note that this matching is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAny { "c_myStringList": { "$containsAny": [ "sample1", "sample2" ] } } This filter will match if either "sample1" or "sample2" is contained in any string within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAny` is "left edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This is a sample", "Sample one", "Sample 2" but not strings like "thisisasamplewithoutspaces". Supports negation.
$containsAll { "c_myStringList": { "$containsAll": [ "sample1", "sample2" ] } } This filter will match if BOTH "sample1" and "sample2" are contained in strings within **`c_myStringList`**. The argument list can have more than two strings. Note that similar to `$contains`, the matching for `$containsAll` is "left-edge n-gram", meaning the argument string must be the beginning of a token. The string "sample" will match strings like "This a sample", "Sample one", and "Sample 2", but not strings like "thisisasamplewithoutspaces". Supports negation.
$startsWith { "c_myStringList": { "$startsWith":"sample" } } This filter will match if any string within **`c_myStringList`** starts with "sample". Does not supports negation. Case Insensitive.
**LIST OF BOOLEAN, OPTION, PHONE, INTEGER, FLOAT, DATE, DATETIME, OR TIME**
Matcher Details
$eq { "c_myDateList": { "$eq": "2019-01-01" } } This filter will match if "2019-01-01" EXACTLY matches any date within **`c_myDateList`**. Supports negation.
$eqAny { "c_myIntegerList": { "$eqAny": [1, 2] } } This filter will match if 1 or 2 EXACTLY match any integer within **`c_myIntegerList`**. The argument list can have more than two elements. Supports negation.
$eqAll { "c_myStringList": { "$eqAll": [ "sample1", "sample2" ] } } This filter will match if both "2019-01-01" AND "2019-01-02" EXACTLY match a date within **`c_myDateList`**. The argument list can have more than two elements. Supports negation.
**LIST OF STRUCT** Filtering on lists of struct types is a bit nuanced. Filtering can only be done on lists of structs of the SAME type. For example, if **`c_myStructList`** is a list of compound fields with the subfields **`age`** and **`name`**, then one can address the **`age`** properties of each field in **`c_myStructList`** as a flattened list of integers and filtering upon them. For example, the following filter: ``` { "c_myStructList.age":{ "$eq": 20 } } ``` will match if any field in the list has an **`age`** property equal to 20. Similarly, any filter that can be applied to lists of integers could be applied to **`age`** in this case (`$eq`, `$eqAll`, `$eqAny`). **HOURS** By filtering on an hours field, you can find which entities are open or closed at a specified time or during a certain time range. All of these filters also take an entity’s holiday hours and reopen date into account.
Matcher Details
$openAt { "hours": { "$openAt": "2019-01-06T13:45" } } This filter would match entities open at the specified time.
$closedAt { "hours": { "$closedAt: "2019-01-06T13:45" } }
$openForAllOf { "hours": { "$openForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter would match only those entities that are open for the entire range between 2019-01-06T13:45 and 2019-01-06T15:00. { "hours": { "$openForAllOf": "2019-05-10" } } This filter would match entities open for the entire 24 hour period on 2019-05-10. You can also supply a year, a month, or an hour to filter for entities open for the entire year, month, or hour, respectively.
$openForAnyOf { "hours": { "$openForAnyOf": { "start": "now", "end": "now+2h" } } } This filter will match any entities that are open for at least a portion of the time range between now and two hours from now.
$closedForAllOf { "hours": { "$closedForAllOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match only those entities that are closed for the entire given time range.
$closedForAnyOf { "hours": { "$closedForAnyOf": { "start": "2019-01-06T13:45", "end": "2019-01-06T15:00" } } } This filter will match any entities that are closed for at least a portion of the given time range.
**Filtering by Dates and Times** **Time zones** The filtering language supports searching both in local time and within a certain time zone. Searching in local time will simply ignore the time zone on the target entities, while providing one will convert the zone of your queried time to the zone of the target entities. To search in local time, simply provide the date or time without any zone: `2019-06-07T15:30` or `2019-06-07`. To conduct a zoned search, provide the name of the time zone in brackets after the time, as it is shown in the tz database: `2019-06-07T15:30[America/New_York]` or `2019-06-06[America/Phoenix]`. **Date and time types** In addition to searching with dates and datetimes, you can also query with years, months, and hours. For example, the filter: ``` { "time.start": { "$eq": "2018" } } ``` would match all start times in the year 2018. The same logic would apply for a month (`2019-05`), a date (`2019-05-01`), or an hour (`2019-05-01T06`). These types also work with ordered searches. For example: ``` { "time.start": { "$lt": "2018" } } ``` would match start times before 2018 (i.e., anything in 2017 or before). On the other hand, the same query with a `$le` matcher would include anything in or before 2018. **"Now" and Date Math** Instead of providing a static date or time, you can also use `now` in place of any date time. When you do so, the system will calculate the time when the query is made and conduct a zoned search. In order to search for a future or past time relative to `now`, you can use date math. For example, you can enter `now+3h` or `now-1d`, which would mean 3 hours from now and 1 day ago, respectively. You can also add and subtract minutes (`m`), months (`M`), and years (`y`). It is also possible to add or subtract time from a static date or datetime. Simply add `||` between the static value and any addition or subtraction. For example, `2019-02-03||+1d` would be the same as `2019-02-04`. You can also convert date and time types to other types. For example, to convert the datetime `2019-05-06T22:15` to a date, use `2019-05-06T22:15||/d`. Doing so would yield the same result as using `2019-05-06`. This method also works with `now`: `now/d` will give you today’s date without the time. **Filtering Across an Entity** It is possible to search for a specific text string across all fields of an entity by using the `$anywhere` matcher.
Matcher Details
$anywhere Matches if the argument text appears anywhere in the entity (including subfields, structs, and lists) { "$anywhere": "hello" } This filter will match all entities that contain the string "hello" or strings that begin with "hello".
**Examples** The following filter will match against entities that: - Are of type `event` (note that entity types can also be filtered by the **`entityTypes`** query parameter) - Have a name that starts with the text "Century" - Have a maximum age between 10 and 20 - Have a minimum age between 5 and 7 - Start after 7 PM (19:00) on August 28, 2018 ``` { "$and":[ { "entityType":{ "$eq":"event" } }, { "name":{ "$startsWith":"Century" } }, { "ageRange.maxValue":{ "$gt":10, "$lt":20 } }, { "ageRange.minValue":{ "$gt":5, "$lt":7 } }, { "time.start":{ "$ge":"2018-08-28T19:00" } } ] } ``` name: filter in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - schema: minLength: 0 type: string description: The comma-separated language codes corresponding to the languages of the profile that the user wishes to retrieve name: languageCodes in: query required: false - schema: multipleOf: 1 maximum: 50 type: number default: '10' description: Number of results to return. name: limit in: query required: false - schema: multipleOf: 1 type: number default: '0' description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. For Live API requests, the offset cannot be higher than 9,950. For Knowledge API the maximum limit is only enforced if a filter and/or sortBy parameter are given. name: offset in: query required: false - schema: minLength: 0 type: string description: If a response to a previous request contained the **`pageToken`** field, pass that field's value as the **`pageToken`** parameter to retrieve the next page of data. name: pageToken in: query required: false - schema: minLength: 0 type: string 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} /accounts/{accountId}/entityprofiles/{entityId}/{languageCode}: get: operationId: getLanguageProfile parameters: - schema: minLength: 0 type: string name: accountId in: path required: true - schema: minLength: 0 type: string description: The external ID of the requested Entity name: entityId in: path required: true - schema: minLength: 0 type: string description: The language code corresponding to the language of the profiles that the user wishes to retrieve name: languageCode in: path required: true - schema: minLength: 0 type: string description: A date in `YYYYMMDD` format. name: v in: query required: true - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Markdown** as HTML. - `false`: **Markdown** fields will be returned as JSON - `true`: **Markdown** fields will be returned as HTML name: convertMarkdownToHTML in: query required: false - schema: minLength: 0 type: string description: | Optional parameter to return fields of type **Rich Text** as HTML. - `false`: **Rich Text** fields will be returned as JSON - `true`: **Rich Text** fields will be returned as HTML name: convertRichTextToHTML in: query required: false - schema: minLength: 0 type: string description: Comma-separated list of field names. When present, only the fields listed will be returned. You can use dot notation to specify substructures (e.g., `"address.line1"`). Custom fields are specified in the same way, albeit with their `c_*` name. name: fields in: query required: false - schema: minLength: 0 type: string default: markdown description: | Present if and only if at least one field is of type "**Legacy Rich Text**." Valid values: * `markdown` * `html` * `none` name: format in: query required: false - 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: {} '400': description: Error Response content: application/json: schema: additionalProperties: false type: object properties: meta: additionalProperties: false type: object properties: errors: uniqueItems: false type: array items: additionalProperties: false type: object properties: code: multipleOf: 1 type: number description: | Code that uniquely identifies the error or warning. message: minLength: 0 type: string description: Message explaining the problem. type: enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING type: string description: List of errors and warnings. uuid: minLength: 0 type: string description: 'Filtering Type: `object`' headers: {} 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` headers: 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: {} /healthy: get: operationId: healthCheck tags: - Health Check summary: Health Check description: | The Health Check endpoint allows you to monitor the status of Yext's systems. A response with a status code other than 200 OK indicates that our systems are not operational. The body of the response may contain information about the status. However, no part of your Yext integration should depend on the content of the response. **NOTE:** This call does not require authentication. responses: '200': description: Health Check Response. content: application/json: schema: type: string /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. ## Required fields * **`locationName`** * **`address`** * **`city`** * **`state`** * **`zip`** ## Optional fields that trigger warnings Submitting invalid values for certain optional fields will not trigger an error response. Instead, the success response will contain warning messages explaining why the invalid optional values were not stored in the system. The fields that generate warning messages are:

* **`logo`** * **`photos`** * **`twitterHandle`** * **`facebookPageUrl`** * **`languages`** 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: | Use 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. **NOTE:** * 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. * Only one of **`entityId`** or **`clientCategoryId`** can be specified at a time. 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' /publishers/{publisherSiteId}/disruptions: parameters: - $ref: '#/components/parameters/publisherSiteId' get: operationId: listPublisherDisruptions tags: - Publisher Disruptions summary: 'Publisher Disruptions: List' description: | Retrieve disruptions for a publisher. parameters: - $ref: '#/components/parameters/v' - name: filter.severities in: query schema: type: array items: type: string enum: - CRITICAL - HIGH - MEDIUM - MINOR description: | Only return disruptions with one of the provided severities. style: form explode: true - name: filter.statuses in: query schema: type: array items: type: string enum: - INVESTIGATING - IDENTIFIED - MONITORING - ON_PUBLISHER - RESOLVED description: | Only return disruptions with one of the provided statuses. style: form explode: true - name: filter.startTime in: query schema: type: string format: date-time description: Inclusive lower bound on `lastEventTimestamp`. - name: filter.endTime in: query schema: type: string format: date-time description: Inclusive upper bound on `lastEventTimestamp`. - name: pageSize in: query schema: type: integer default: 50 minimum: 0 maximum: 1000 description: Number of results to return. - name: pageToken in: query schema: type: string description: | If a response to a previous request contained `meta.pagination.pageToken`, pass that field's value as the `pageToken` parameter to retrieve the next page of data. - name: languageCode in: query schema: type: string description: Locale code for translated disruption content, such as `en_US` or `fr_FR`. responses: '200': $ref: '#/components/responses/ListPublisherDisruptionsResponse' default: $ref: '#/components/responses/ErrorResponse' /publishers/{publisherSiteId}/disruptions/{disruptionExternalId}/statusUpdates: parameters: - $ref: '#/components/parameters/publisherSiteId' - name: disruptionExternalId in: path required: true schema: type: string description: External ID of the disruption. get: operationId: listPublisherDisruptionStatusUpdates tags: - Publisher Disruptions summary: 'Publisher Disruptions: List Status Updates' description: | Retrieve status updates for a publisher disruption. parameters: - $ref: '#/components/parameters/v' - name: pageSize in: query schema: type: integer default: 50 minimum: 0 maximum: 1000 description: Number of results to return. - name: pageToken in: query schema: type: string description: | If a response to a previous request contained `meta.pagination.pageToken`, pass that field's value as the `pageToken` parameter to retrieve the next page of data. - name: languageCode in: query schema: type: string description: Locale code for translated status update content, such as `en_US` or `fr_FR`. responses: '200': $ref: '#/components/responses/ListPublisherDisruptionStatusUpdatesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/publishers: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listPublishers parameters: - name: subset in: query schema: type: string default: RELEVANT_ONLY description: | One of the following: - ALL - return all publishers - RELEVANT_ONLY - only return publishers based on available subscriptions and supported countries - name: entityType in: query schema: type: array items: type: string enum: - LOCATION - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - RESTAURANT - ATM - EVENT - HOTEL description: | When specified, only publishers that support the specified entity types will be returned **Example:** `LOCATION,EVENT` tags: - Listings summary: 'Publishers: List' description: | Retrieve a list of publishers included in an account's subscription responses: '200': $ref: '#/components/responses/ListPublishersResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/accuracy: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listListingAccuracy parameters: - name: entityId in: query required: true schema: type: string description: ID of the entity to retrieve listing accuracy results for. - name: publisherIds in: query schema: type: array items: type: string description: | List of publisher IDs. If no IDs are specified, the endpoint queries live publishers supported by Listings Accuracy and returns only publishers with a latest completed verifier result for the entity. If a publisher ID is specified but is unknown or is not live and supported by Listings Accuracy, the request fails. If a specified publisher is valid but has no latest completed verifier data, that publisher is omitted from `listingAccuracy`. To request multiple publishers, repeat this query parameter once per publisher. example: - MAPQUEST - FACEBOOK tags: - Listings summary: 'Listings Accuracy: List' description: | Retrieve the latest completed listing accuracy comparison results for an entity. Results include field-level comparison data for each publisher with a latest completed verifier result. Requested publishers that are valid but have no latest completed verifier data are omitted from the response. responses: '200': $ref: '#/components/responses/ListListingAccuracyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/listings: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listListings parameters: - name: limit in: query schema: type: integer default: 100 maximum: 100 description: Number of results to return - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/entitiesPageToken' - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' - name: statuses in: query schema: type: array items: type: string enum: - WAITING_ON_YEXT - WAITING_ON_CUSTOMER - WAITING_ON_PUBLISHER - LIVE - UNAVAILABLE - OPTED_OUT description: | When specified, only Listings with the provided statuses will be returned **Example:** `WAITING_ON_YEXT,WAITING_ON_CUSTOMER` - name: language in: query schema: type: string default: en description: | One of the language codes that we support: - cs - Czech - da - Danish - nl - Dutch - en - English - en_GB - English (UK) - fi - Finnish - fr - French (France) - de - German (Germany) - hu - Hungarian - it - Italian - ja - Japanese - no - Norwegian - pt - Portuguese (Portugal) - sk - Slovak - es - Spanish (Spain) - sv - Swedish - tr - Turkish - zh_Hans - Chinese (Simplified) - zh_Hant - Chinese (Traditional) tags: - Listings summary: 'Listings: List' description: | Retrieve all Listings matching the given criteria including status and reasons why a Listing may be unavailable The results will first be sorted by publisher and then by Location. **Support for `all` macro:** If you would like to use this endpoint to take action on your account and all of its sub-accounts, you can use the `all` macro in place of your account ID in your request URLs. For more information, see the "Account ID" section of "Policies and Conventions" at the top of this page. responses: '200': $ref: '#/components/responses/ListListingsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/listings/optin: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' put: operationId: optInListings parameters: - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' tags: - Listings summary: 'Listings: Opt In' description: | Opts designated locations into designated publishers **NOTE:** The number of Location IDs multiplied by the number of Publisher IDs is capped at 100. If you exceed this, you will receive a 400 error response. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/listings/optout: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' put: operationId: optOutListings parameters: - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' tags: - Listings summary: 'Listings: Opt Out' description: | Opts designated locations out of designated publishers **NOTE:** The number of Location IDs multiplied by the number of Publisher IDs is capped at 100. If you exceed this, you will receive a 400 error response. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/listings/confirmsync: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' put: operationId: confirmSyncListings parameters: - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' - name: pageToken in: query schema: type: string description: | If the **`v`** param is after `20260401`, a **`pageToken`** will be returned if the result is over 1000 listings. This token can be used in the next request to process the next batch of listings. style: simple tags: - Listings summary: 'Listings: Confirm Sync' description: | Approves designated locations to sync to designated publishers. See [here](https://hitchhikers.yext.com/docs/listings/confirm-sync/) for more details about confirm sync. **NOTE:** If the **`v`** param is after `20260401`, Yext will filter to all applicable listings in the provided filter. If the result is over 1000 listings, a **`pageToken`** will be provided to allow processing of the next batch. responses: '200': $ref: '#/components/responses/ConfirmSyncResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/listings/forcesync: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' put: operationId: forceSyncListings parameters: - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' tags: - Listings summary: 'Listings: Force Sync' description: | Trigger designated locations to sync to designated publishers. See [here](https://help.yext.com/hc/en-us/articles/360020003051-Force-Sync-a-Listing) for more details about force sync. **NOTE:** The number of Location IDs multiplied by the number of Publisher IDs is capped at 1000. If you exceed this, you will receive a 400 error response. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/publishersuggestions: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listPublisherSuggestions parameters: - name: limit in: query schema: type: integer default: 10 maximum: 50 description: Number of results to return - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' - name: statuses in: query schema: type: array items: type: string enum: - WAITING_ON_CUSTOMER - ACCEPTED - REJECTED - EXPIRED description: | When specified, only Publisher Suggestions with the provided statuses will be returned **Example:** WAITING_ON_CUSTOMER,EXPIRED style: simple tags: - Listings summary: 'Publisher Suggestions: List' description: Retrieve suggestions publishers have submitted for the Locations in an account responses: '200': $ref: '#/components/responses/ListPublisherSuggestionsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/publishersuggestions/{suggestionId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: suggestionId in: path schema: type: string required: true get: operationId: getPublisherSuggestion tags: - Listings summary: 'Publisher Suggestions: Get' description: Fetches details of a specific Publisher Suggestion responses: '200': $ref: '#/components/responses/PublisherSuggestionResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updatePublisherSuggestion parameters: - name: status in: query schema: type: string enum: - ACCEPTED - REJECTED required: true description: The status of the Publisher Suggestion tags: - Listings summary: 'Publisher Suggestions: Update' description: | Accept or reject a Publisher Suggestion. **NOTE:** When sending requests to this endpoint, you must provide your Yext user ID in the **`Yext-User-Id`** header. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/duplicates: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listDuplicates parameters: - name: limit in: query schema: type: integer default: 10 maximum: 50 description: Number of results to return - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/listingsLocationIds' - $ref: '#/components/parameters/listingsPublisherIds' - name: statuses in: query schema: type: array items: type: string enum: - POSSIBLE_DUPLICATE - SUPPRESSION_REQUESTED - SUPPRESSED - UNAVAILABLE description: | When specified, only Duplicates with the provided statuses will be returned **Example:** POSSIBLE_DUPLICATE,SUPPRESSION_REQUESTED style: simple tags: - Listings summary: 'Duplicates: List' description: | Retrieve Duplicates for an account If the **`v`** parameter is `20180802` or later: only duplicates of live listings (**`status`**: `LIVE`) will be included responses: '200': $ref: '#/components/responses/ListDuplicatesResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createDuplicate parameters: - $ref: '#/components/parameters/listingsLocationId' - $ref: '#/components/parameters/listingsPublisherIdQuery' - name: url in: query schema: type: string required: true description: URL of the Duplicate listing tags: - Listings summary: 'Duplicates: Create' description: | Creates a new Duplicate with **`status`** `SUPPRESSION_REQUESTED`. **NOTE:** When sending requests to this endpoint, you must provide your Yext user ID in the **`Yext-User-Id`** header. responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/duplicates/{duplicateId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: duplicateId in: path schema: type: string required: true delete: operationId: deleteDuplicate tags: - Listings summary: 'Duplicates: Delete' description: | Indicates that a Duplicate should be ignored. **NOTE:** When sending requests to this endpoint, you must provide your Yext user ID in the **`Yext-User-Id`** header. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: suppressDuplicate tags: - Listings summary: 'Duplicates: Suppress' description: | Request suppression of a Duplicate. **NOTE:** When sending requests to this endpoint, you must provide your Yext user ID in the **`Yext-User-Id`** header. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/verifications/{publisherId}/{locale}/methods: get: operationId: listMethods parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' - $ref: '#/components/parameters/locale' - $ref: '#/components/parameters/listingsVerficationEntityIds' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/verificationLimit' - $ref: '#/components/parameters/offset' tags: - Listings summary: 'Verification Methods: List' description: | Retrieve verification methods for entities in an account responses: '200': $ref: '#/components/responses/ListMethodsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/verifications/{publisherId}/statuses: get: operationId: listStatuses parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' - $ref: '#/components/parameters/listingsVerficationEntityIds' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/verificationLimit' - $ref: '#/components/parameters/offset' tags: - Listings summary: 'Verification Statuses: List' description: | Retrieve verification statuses for entities in an account responses: '200': $ref: '#/components/responses/ListStatusesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/verifications/{publisherId}/{locale}/initiate: post: operationId: InitiateVerification requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/VerificationInitiation' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' - $ref: '#/components/parameters/locale' tags: - Listings summary: 'Verification: Initiate' description: | Initiate verification for entities in an account. This request will trigger verification codes being sent to the specified addresses, phone numbers, or email addresses. responses: '200': $ref: '#/components/responses/InitiateVerificationResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/verifications/{publisherId}/complete: post: operationId: CompleteVerification requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/VerificationCompletion' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' tags: - Listings summary: 'Verification: Complete' description: | Provides verification codes to complete the verification for entities in an account. responses: '200': $ref: '#/components/responses/CompleteVerificationResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/admins/{publisherId}: get: operationId: listAdmins parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' - $ref: '#/components/parameters/listingsVerficationEntityIds' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/verificationLimit' - $ref: '#/components/parameters/offset' tags: - Listings summary: 'Listing Admins: List' description: | Retrieve listing admins for entities in an account. responses: '200': $ref: '#/components/responses/ListAdminsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/admins/{publisherId}/invite: post: operationId: InviteAdmins requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/AdminInvite' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/listingsPublisherId' tags: - Listings summary: 'Listing Admin: Invite' description: | Sends invitations to new listing admins for entities in an account. For Google Business Profile listings, the admins will be given owner-level access. responses: '200': $ref: '#/components/responses/InviteAdminsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/entitylistings: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: listEntityListings parameters: - $ref: '#/components/parameters/listingsEntityIds' - $ref: '#/components/parameters/listingsEventPublisherIds' - name: statuses in: query schema: type: array items: type: string enum: - NOT_SYNCED - SYNC_IN_PROGRESS - LIVE - UPDATE_IN_PROGRESS - CANCELING_SYNC - NOT_APPLICABLE - DELETE_PENDING - DELETE_FAILED - DELETED - SYNC_STOPPED description: | Defaults to all Listings whose **`status`** is not `DELETED` or `SYNC_STOPPED`. When specified, only Listings with the provided statuses will be returned. - name: language in: query schema: type: string default: en description: | One of the following language codes: - `cs` - Czech - `da` - Danish - `nl` - Dutch - `en` - English - `en_GB` - English (UK) - `fi` - Finnish - `fr` - French (France) - `de` - German (Germany) - `hu` - Hungarian - `it` - Italian - `ja` - Japanese - `no` - Norwegian - `pt` - Portuguese (Portugal) - `sk` - Slovak - `es` - Spanish (Spain) - `sv` - Swedish - `tr` - Turkish - `zh_Hans` - Chinese (Simplified) - `zh_Hant` - Chinese (Traditional) - $ref: '#/components/parameters/pageToken' - name: limit in: query schema: type: integer default: 100 maximum: 100 description: Number of results to return - $ref: '#/components/parameters/offset' tags: - Listings summary: 'Entity Listings: List' description: | Retrieve all Entity Listings matching the given criteria. Includes the status of each Listing and reasons why a Listing may not be live. This endpoint currently only supports Event Listings. The results will first be sorted by publisher and then by Entity. **Support for `all` macro:** If you would like to use this endpoint to take action on your account and all of its sub-accounts, you can use the `all` macro in place of your account ID in your request URLs. For more information, see the "Account ID" section of "Policies and Conventions" at the top of this page. responses: '200': $ref: '#/components/responses/ListEntityListingsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/listings/delete: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' delete: operationId: deleteListings parameters: - $ref: '#/components/parameters/listingsEntityIds' - $ref: '#/components/parameters/listingsEventPublisherIds' tags: - Listings summary: 'Entity Listings: Delete' description: | Deletes event listings from publishers. If deletion is not supported by the publisher, then service is removed instead. **NOTE:** You can delete a maximum of 100 listings in a single request. If the number of Entity IDs multiplied by the number of Publisher IDs in your request exceeds 100, you will receive a 400 error response. **Support for `all` macro:** If you would like to use this endpoint to take action on your account and all of its sub-accounts, you can use the `all` macro in place of your account ID in your request URLs. For more information, see the "Account ID" section of "Policies and Conventions" at the top of this page. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/questions: parameters: - $ref: '#/components/parameters/accountId' get: operationId: listQuestions tags: - Listings summary: | Questions: List parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/QuestionAnswerFilter' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/pageToken' description: | Retrieve a list of Questions within an account. **NOTE**: The Google Q&A API was discontinued on November 3rd, 2025. This endpoint now only returns existing questions stored in Yext. responses: '201': $ref: '#/components/responses/ListQuestionsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/questions/{questionId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/questionId' get: operationId: getQuestion summary: 'Question: Get' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/questionId' tags: - Listings description: | Retrieve information for a Question **NOTE**: The Google Q&A API was discontinued on November 3rd, 2025. This endpoint now only returns existing questions stored in Yext. responses: '201': $ref: '#/components/responses/QuestionResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/analytics/catalog: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getCatalog tags: - Analytics summary: Catalog description: List of all metrics for which reporting data is available, along with their completed dates. responses: '200': $ref: '#/components/responses/CatalogResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/analytics/maxdates: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getMaxDates tags: - Analytics summary: Max Dates description: Fetch the completed date for Listings and Bing metrics. Fetching the completed date for individual metrics can be done using the catalog endpoint. responses: '200': $ref: '#/components/responses/MaxDatesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/analytics/reports: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: async in: query schema: type: boolean description: Defaults to false. When true, the report’s ID will be returned immediately and the report results can be fetched later. When false, the report results will be returned immediately, but an error may occur if the data requested is too large. - name: callback in: query schema: type: string description: | Optional. When async=true and callback is specified, the provided URL will be called when the report is ready. The URL must be of the form: POST https://[your domain]/[your path] It must accept the following parameters: id: (string) - The ID of the report request which completed. status: (string) - One of [DONE, FAILED] indicating the result of the request. statusCode: (int) - An HTTP status code indicating the result of the request. message: (string) - When status=FAILED, contains an error message. url: (string) - When status=DONE, contains the URL to download the report data as a text file. post: operationId: createReports tags: - Analytics summary: Reports description: | Create a report to retrieve analytics for each of your products using synchronous or asynchronous requests depending on the size of your data. For more information available in the Reports API, check our documentation below: * [Metrics in Analytics](https://help.yext.com/hc/en-us/articles/360000001103-Metrics-in-Analytics) * [Dimensions in Analytics](https://help.yext.com/hc/en-us/articles/5901921968027-Dimensions-in-Analytics) requestBody: description: JSON object containing any filters to be applied to the report content: application/json: schema: $ref: '#/components/schemas/CreateReportRequestBody' responses: '200': $ref: '#/components/responses/CreateReportsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/analytics/standardreports/{reportId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: reportId in: path schema: type: integer required: true get: operationId: reportStatus tags: - Analytics summary: Report Status description: Checks the status of a Report created with async=true. responses: '200': $ref: '#/components/responses/ReportStatusResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/logs/tables: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: API Key associated with your App that has access to Logs endpoint. required: true get: operationId: GetTables tags: - LogsAPI summary: Tables description: Retrieve tables that can be queried in the POST Query endpoint of the Logs API. responses: '200': $ref: '#/components/responses/GetTablesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/logs/tables/{table}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: API Key associated with your App that has access to Logs endpoint. required: true - name: table in: path schema: type: string required: true description: Table to query get: operationId: GetTable tags: - LogsAPI summary: Table Schema description: Retrieve schema for table in the Logs API. Available tables can be found by querying the GET Tables endpoint of the Logs API. responses: '200': $ref: '#/components/responses/GetTableResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/logs/tables/{table}/query: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: API Key associated with your App that has access to Logs endpoint. required: true - name: table in: path schema: type: string required: true description: Table to query post: operationId: postQuery tags: - LogsAPI summary: Query description: Retrieve data from table. Available tables can be found by querying the GET Tables endpoint of the Logs API. requestBody: description: JSON object containing fields, pageSize, sorting and filters to be applied to request. content: application/json: schema: $ref: '#/components/schemas/CreateQueryRequestBody' responses: '200': $ref: '#/components/responses/CreateQueryResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews: parameters: - $ref: '#/components/parameters/accountId' get: operationId: listReviews summary: 'Reviews: List' tags: - Reviews description: | Retrieve all Reviews matching the given criteria. **NOTE:** Not all publishers' reviews will be included in the response. For more details, please contact your Account Manager. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: limit in: query schema: type: integer default: 10 maximum: 100 description: Number of results to return. - name: offset in: query required: false schema: type: integer default: 0 maximum: 9900 description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. If the **`v`** parameter is before `20211115`, the maximum offset is not enforced. However, users are still encouraged to migrate to **`pageToken`** for queries requiring large offsets, as these may result in errors. - name: entityIds in: query schema: type: array items: type: string description: | When provided, only reviews for the requested entities will be returned. Before 12/13/21, the parameter name was **`locationIds`**. Specifying either **`locationsIds`** or **`entityIds`** as the parameter name will have the same result. By default, reviews will be returned for all entities subscribed to Review Monitoring. **Example:** entity123,entity456,entity789 style: simple - name: apiIdentifiers in: query schema: type: array items: type: string description: | When provided, only reviews for the requested API identifiers will be returned. style: simple - name: folderId in: query schema: type: string description: When provided, only reviews for locations in the given folder and its subfolders will be included in the results. - name: countries in: query schema: type: array items: type: string description: When present, only reviews for locations in the given countries will be returned. Countries are denoted by ISO 3166 2-letter country codes. - name: locationLabels in: query schema: type: array items: type: string description: When present, only reviews for locations with the provided labels will be returned. - $ref: '#/components/parameters/listingsPublisherIds' - name: reviewContent in: query schema: type: string description: When specified, only reviews that include the provided content will be returned. - name: minRating in: query schema: type: number format: double description: When specified, only reviews with the provided minimum rating or higher will be returned. - name: maxRating in: query schema: type: number format: double description: When specified, only reviews with the provided maximum rating or lower will be returned. - name: minPublisherDate in: query schema: type: string format: date description: | (`YYYY-MM-DD` format) When specified, only reviews with a publisher date on or after the given date will be returned. If the **`v`** parameter is before `20170617`: returns reviews with a publisher date on or after the given date in **EST** If the **`v`** parameter is `20170617` or later: returns reviews with a publisher date on or after the given date in **UTC** - name: maxPublisherDate in: query schema: type: string format: date description: | (`YYYY-MM-DD` format) When specified, only reviews with a publisher date on or before the given date will be returned. If the **`v`** parameter is before `20170617`: returns reviews with a publisher date on or before the given date in **EST** If the **`v`** parameter is `20170617` or later: returns reviews with a publisher date on or before the given date in **UTC** - name: minLastYextUpdateDate in: query schema: type: string format: date description: | (`YYYY-MM-DD` format) When specified, only reviews with a last Yext update date on or after the given date will be returned. If the **`v`** parameter is before `20170617`: returns revies with a last Yext update date on or after the given date in **EST** If the **`v`** parameter is `20170617` or later: returns revies with a last Yext update date on or after the given date in **UTC** - name: maxLastYextUpdateDate in: query schema: type: string format: date description: | (`YYYY-MM-DD` format) When specified, only reviews with a last Yext update date on or before the given date will be returned. If the **`v`** parameter is before `20170617`: returns reviews with a last Yext update date on or before the given date in **EST** If the **`v`** parameter is `20170617` or later: returns reviews with a last Yext update date on or before the given date in **UTC** - name: awaitingResponse in: query schema: type: string enum: - REVIEW - COMMENT - REVIEW_OR_COMMENT description: | When specified, only reviews that are awaiting an owner reply on the given objects will be returned. For example, when `awaitingResponse=COMMENT`, reviews will only be returned if they have at least one comment that has not been responded to by the owner. - name: minNonOwnerComments in: query schema: type: integer description: When specified, only reviews that have at least the provided number of non-owner comments will be returned. - name: reviewerName in: query schema: type: string description: When specified, only reviews whose authorName contains the provided string will be returned. - name: status in: query schema: type: string enum: - LIVE - QUARANTINED - REMOVED description: | When specified, only reviews with the given **`status`** values will be returned. The **`status`** parameter will only be respected with the inclusion of a **`v`** parameter of `20170830` or later. - name: pageToken in: query schema: 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. The **`pageToken`** parameter will only be respected with the inclusion of a **`v`** parameter of `20170901` or later. - name: reviewLanguage in: query schema: type: string description: | When provided, only reviews in the given languages will be included in the results. Languages must be specified by their ISO 639-1 codes. If specifying multiple languages, enter the language codes as a comma-separated list. **Example:** 'en,fr,zh' - name: labelIds in: query schema: type: array items: type: string description: When present, only reviews with the provided review label IDs will be returned. - name: reviewType in: query schema: type: string enum: - Rating - Recommendation description: | When specified, only reviews that are of the given **`reviewType`** will be returned. Only applicable to Facebook reviews. The **`reviewType`** parameter will only be respected with the inclusion of a **`v`** parameter of `20181002` or later. - name: recommendation in: query schema: type: string enum: - Recommended - Not Recommended description: | When specified, only reviews with the given **`recommendation`** value will be returned. Only applicable to Facebook reviews. The **`recommendation`** parameter will only be respected with the inclusion of a **`v`** parameter of `20181002` or later. - name: flagStatus in: query schema: type: string enum: - FLAGGED - NOT_FLAGGED description: | When specified, only reviews with the given **`flagStatus`** value will be returned. **`flagStatus`** indicates whether the review has been flagged for inappropriate or irrelevant content. For review publishing, Yext recommends filtering to reviews with `flagStatus = NOT_FLAGGED`, as flagged reviews are being examined for inappropriate or irrelevant content. Note that only First Party and External First Party reviews can be flagged. - name: isYextResponseEligible in: query schema: type: boolean description: | When specified, used to filter reviews based on whether they are eligible for response through Yext (based on their publisher and, for first party reviews, anonymization status). If set to `true`, only such reviews will be included in the response, and if set to `false` such reviews will be excluded in the response. Default (unset) means reviews will be included regardless of their eligibility for response through Yext. Note that this parameter does NOT filter reviews based on whether they already have a response; to do that use the **`awaitingResponse`** parameter. responses: '200': $ref: '#/components/responses/ReviewsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createReview tags: - Reviews requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReview' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' summary: 'Reviews: Create' description: | Create a new External First Party Review. responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/{reviewId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/reviewId' get: operationId: getReview summary: 'Review: Get' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' tags: - Reviews description: Retrieve a specific Review. responses: '200': $ref: '#/components/responses/ReviewResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReview' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' operationId: updateReview tags: - Reviews summary: 'Review: Update' description: | Updates an External First Party Review or a First Party Review.

**NOTE:** Despite using the `PUT` method, Reviews: Update only updates supplied fields. Omitted fields are not modified.

responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/{reviewId}/comments: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/reviewId' post: operationId: createComment summary: 'Comment: Create' tags: - Reviews description: | Creates a new Comment on a Review. **NOTE:** When the **Compliant Review Response** setting is enabled for your account and you are providing an `attestation`, you must include your Yext user ID in the **`Yext-User-Id`** header. The comment will be processed asynchronously for compliance review, and a **202 Accepted** response will be returned.

## Required fields * **`content`**

## Optional fields * **`parentId`** * **`visibility`** * **`date`** * **`suppressReviewerContact`** * **`attestation`** (only required when Compliant Review Response is enabled)

## Response Behavior * When `attestation` is provided (Compliant Review Response enabled): Returns **202 Accepted** - comment will be published after compliance review * When `attestation` is not provided (Compliant Review Response disabled): Returns **201 Created** with comment ID, or **202 Accepted** if asynchronous processing is needed

requestBody: $ref: '#/components/requestBodies/commentRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' responses: '201': $ref: '#/components/responses/CreateReviewCommentResponse' '202': $ref: '#/components/responses/ReviewCommentTimeoutResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/{reviewId}/generateComment: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/reviewId' post: operationId: generateComment summary: 'Comment: Generate' tags: - Reviews description: | Gets a content generated response for a particular review parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' responses: '200': $ref: '#/components/responses/GenerateReviewCommentResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/{reviewId}/comments/{commentId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/reviewId' - $ref: '#/components/parameters/commentId' put: operationId: updateComment summary: 'Comment: Update' tags: - Reviews description: | Updates a Comment on a Review.

## Optional fields * **`content`** * **`visibility`**

requestBody: $ref: '#/components/requestBodies/commentUpdateRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' - $ref: '#/components/parameters/commentId' responses: '200': $ref: '#/components/responses/EmptyResponse' '202': $ref: '#/components/responses/ReviewCommentTimeoutResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteComment summary: 'Comment: Delete' tags: - Reviews description: | Deletes a Comment on a Review.

parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' - $ref: '#/components/parameters/commentId' responses: '200': $ref: '#/components/responses/EmptyResponse' '202': $ref: '#/components/responses/ReviewCommentTimeoutResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviewinvites: parameters: - $ref: '#/components/parameters/accountId' get: operationId: listReviewInvitations summary: 'Review Invitations: List' tags: - Reviews description: Retrieves all review invitations for an account parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: limit in: query schema: type: integer default: 10 maximum: 100 description: Number of results to return - name: offset in: query required: false schema: type: integer default: 0 maximum: 9900 description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. If the **`v`** parameter is before `20240626`, the maximum offset is not enforced. However, users are still encouraged to migrate to **`pageToken`** for queries requiring large offsets, as these may result in errors. - name: pageToken in: query schema: 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. The **`pageToken`** parameter will only be respected with the inclusion of a **`v`** parameter of `20240626` or later. - name: locationIds in: query schema: type: array items: type: string description: | When provided, only invitations for the requested locations will be returned. **Example:** loc123,loc456,loc789 style: simple - name: folderIds in: query schema: type: array items: type: string description: | When provided, only invitations for locations in the given folders and their subfolders will be included in the results. - name: locationLabels in: query schema: type: array items: type: string description: | When present, only invitations for locations with the provided labels will be returned. - name: templateIds in: query schema: type: array items: type: string description: When provided, only invitations using the provided templateIds will be returned. - name: status in: query schema: type: string enum: - ACCEPTED - REJECTED - PENDING description: When provided, only invitations of the chosen status will be returned. - name: type in: query schema: type: string enum: - EMAIL - SMS description: When provided, only invitations of the selected type will be returned. responses: '200': $ref: '#/components/responses/ReviewInvitationsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createReviewInvites tags: - Reviews summary: 'Review Invitations: Create' description: | Sends review invitations to one or more consumers.

## Optional fields * **`templateId`** * **`transactionId`**

requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/CreateReviewInvitationRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' responses: '201': $ref: '#/components/responses/CreateReviewInvitationsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviewinvites/{invitationUid}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/invitationId' - $ref: '#/components/parameters/v' get: operationId: getReviewInvitation summary: 'Review Invitation: Get' tags: - Reviews description: Retrieve a specific review invitation. responses: '200': $ref: '#/components/responses/ReviewInvitationResponse' default: $ref: '#/components/responses/ErrorResponse' put: requestBody: $ref: '#/components/requestBodies/updateReviewInvitationRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/invitationId' operationId: updateReviewInvitation summary: 'Review Invitation: Update' tags: - Reviews description: | Supports updating an existing review invitation. This endpoint will not create a new review invitation or trigger a new SMS/Email to be sent, it will only update the data and/or metadata for an existing review invitation. Any optional parameters which are excluded from the request will simply be ignored. responses: '200': $ref: '#/components/responses/UpdateReviewInvitationResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteInvitation summary: 'Review Invitation: Delete' tags: - Reviews description: Delete a specific review invitation. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/{reviewId}/labels: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/reviewId' put: operationId: updateReviewLabels summary: 'Review Labels: Update' tags: - Reviews description: Assigns the specified review labels to the specified review, replacing existing labels on the review. requestBody: $ref: '#/components/requestBodies/updateReviewLabelsRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/reviewId' responses: '200': $ref: '#/components/responses/UpdateReviewLabelsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/reviews/settings/generation: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getReviewGenerationSettings tags: - Reviews summary: 'Review Generation Settings: Get' description: Returns all current generation settings for a specified account. responses: '200': $ref: '#/components/responses/ReviewGenerationSettingsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: updateReviewGenerationSettings tags: - Reviews summary: 'Review Generation Settings: Update' description: | Updates any generation settings specified in a specified account. Call may include any/all settings available to the account. Settings not included will remain unchanged. requestBody: $ref: '#/components/requestBodies/reviewGenerationSettingsRequest' parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' responses: '200': $ref: '#/components/responses/UpdateReviewGenerationSettingsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/workflowRules: parameters: - $ref: '#/components/parameters/accountId' get: operationId: listReviewWorkflowRules summary: 'Review Workflow Rules: List' tags: - Reviews parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: pageSize in: query schema: type: integer default: 25 maximum: 25 description: The maximum number of workflow rules to return. Defaults to 25. - name: pageToken in: query schema: 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. - name: filter in: query schema: type: string description: | CEL expression used to filter workflow rules. Filters can only be applied to **`assignee`**, **`type`**, and **`enabled`**. description: | Retrieve the Review Workflow Rules configured for the account. responses: '200': $ref: '#/components/responses/workflowRulesResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createReviewWorkflowRule summary: 'Review Workflow Rules: Create' tags: - Reviews parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowRule' description: | Creates a Review Workflow Rule. responses: '200': $ref: '#/components/responses/workflowRuleResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/workflowRules/{workflowRuleId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/workflowRuleId' - $ref: '#/components/parameters/v' get: operationId: getReviewWorkflowRule summary: 'Review Workflow Rules: Get' tags: - Reviews description: Retrieve a specific Review Workflow Rule. responses: '200': $ref: '#/components/responses/workflowRuleResponse' default: $ref: '#/components/responses/ErrorResponse' patch: operationId: updateReviewWorkflowRule summary: 'Review Workflow Rules: Update' tags: - Reviews parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/workflowRuleId' - name: updateMask in: query required: true schema: type: string description: | Comma-separated list of fields to update on the workflow rule. Supported values: `assignee`, `assignee_user_group`, `display_name`, `enabled`, `domain_configuration`, `rule_type`, `due_date` Example: `display_name,enabled` requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRule' description: | Updates a single Review Workflow Rule. **NOTE:** Review Workflow Rules: Update only updates supplied fields. Omitted fields are not modified. responses: '200': $ref: '#/components/responses/workflowRuleResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteReviewWorkflowRule summary: 'Review Workflow Rules: Delete' tags: - Reviews description: Deletes a Review Workflow Rule. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/posts: parameters: - $ref: '#/components/parameters/accountId' get: operationId: listPosts summary: 'Posts: List' tags: - Social description: | Retrieve Social Posts matching the given criteria. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: pageToken in: query schema: 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. - name: postIds in: query schema: type: array items: type: string description: Only return posts with the postIDs in the specified list. - name: entityPostIds in: query schema: type: array items: type: string description: Only return entityPosts with entityPostIds in the specified list. - name: entityIds in: query schema: type: array items: type: string description: Only return posts for the specified entities. - name: publishers in: query schema: type: array items: type: string enum: - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS description: | Only return posts on the specified publishers. - name: text in: query schema: type: string description: Only return posts with the specified text. - name: status in: query schema: type: array items: type: string description: | Only include posts which match one of the specified statuses: * `POST_SCHEDULED` * `POST_AWAITING_APPROVAL` * `POST_SUCCEEDED` * `POST_PROCESSING` * `DELETE_PROCESSING` * `POST_FAILED` * `DELETE_FAILED` * `REJECTED_BY_APPROVER` responses: '200': $ref: '#/components/responses/PostsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createPosts summary: 'Post: Create' tags: - Social description: | Create a new social post. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePost' responses: '200': $ref: '#/components/responses/PostResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/posts/{postId}: parameters: - $ref: '#/components/parameters/accountId' get: operationId: getPost summary: 'Post: Get' tags: - Social description: | Retrieve a specific social post. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: postId in: path required: true schema: type: string description: The ID of a specific post. responses: '200': $ref: '#/components/responses/PostResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updatePost summary: 'Post: Update' tags: - Social description: | Update a social post. **NOTE:** Updates are only allowed for posts with no entity posts currently processing. Entity posts that failed to publish will not be updated by subsequent requests to the update endpoint. Updates to Google Posts may not be reflected immediately. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: postId in: path required: true schema: type: string description: | The ID of a specific post. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePost' responses: '200': $ref: '#/components/responses/PostResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deletePost summary: 'Post: Delete' tags: - Social description: | Delete a social post. **NOTE:** Posts that have status `POST_PROCESSING` may not be deleted. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: postId in: path required: true schema: type: string description: | The ID of a specific post. To delete individual entity posts, please use the [**Entity Post: Delete**](#operation/deleteEntityPost) endpoint. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/posts/generatePostText: post: operationId: generatePostText summary: 'Post: Generate Text' tags: - Social description: | Generates caption, by using API, based on a set of criteria. The generated caption should then be provided as a value against the `text` field in the Post: Create call. Please note that this endpoint returns embedded fields using double brackets. You MUST use a **`v`** parameter of`20250514` or greater in the Post: Create call in order for the embedded fields to resolve correctly. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GeneratePostText' responses: '200': description: Generate Post Text Response content: application/json: schema: title: GeneratePostTextResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: postText: type: string description: | The generated post text. Please note that the generated post text may contain embedded fields. Please use a **`v`** parameter of`20250514` or greater in the Post: Create endpoint in order for the embedded fields to resolve correctly. default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/entityPosts/{entityPostId}: delete: operationId: deleteEntityPost summary: 'Entity Post: Delete' tags: - Social description: | Delete a specific entity post parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/entityPostId' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/entityPosts/{entityPostId}/comments: post: operationId: createEntityPostComment summary: 'Comment: Create' tags: - Social description: | Comment on a specific entity post. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/entityPostId' requestBody: required: false content: application/json: schema: type: object properties: text: type: string description: The text of the comment. parentCommentId: type: string description: | If the comment is in response to another comment, this is the ID of the parent comment. **Instagram and Facebook only** responses: '200': $ref: '#/components/responses/CreateCommentResponse' default: $ref: '#/components/responses/ErrorResponse' get: operationId: getEntityPostComments summary: 'Entity Post: Comments' tags: - Social description: | Provided an entityPostId, returns a list of comments with pagination support. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/entityPostId' - name: pageToken in: query schema: 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. responses: '200': $ref: '#/components/responses/EntityPostCommentsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/entityPosts/{entityPostId}/comments/{commentId}: delete: operationId: deleteEntityPostComment summary: 'Comment: Delete' tags: - Social description: | Delete a comment on a specific entity post. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/entityPostId' - $ref: '#/components/parameters/commentId' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/social/video: post: operationId: uploadVideo summary: 'Video: Upload' tags: - Social description: | Upload a video to be used in a post. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UploadVideo' responses: '200': $ref: '#/components/responses/UploadVideoResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/social/eligibility: get: operationId: socialEligibility summary: 'Eligibility: Get' tags: - Social description: | Fetch publisher eligibility for a given set of entities. If a publisher is ELIGIBLE for an entity, that means it can be posted to. If a publisher is INELIGIBLE for an entity, that means that it cannot be posted to. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: publishers in: query required: true schema: type: array items: type: string enum: - APPLE - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS description: The publisher(s) for which to check for eligibility - name: entityIds in: query required: true schema: type: array items: type: string description: ID(s) of the entities for which to check for eligibility responses: '200': $ref: '#/components/responses/SocialEligibilityResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/social/conversation: get: operationId: getSocialConversation summary: 'Conversation: Get' tags: - Social description: | Fetches a full conversation for a `userId` \ `entityId` \ `publisher`. The `userId` can be retrieved from the Messages: List response. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/pageToken' - name: entityId in: query required: true schema: type: string description: ID of the entity to fetch a conversation for. - name: publisher in: query required: true schema: type: string enum: - INSTAGRAM - FACEBOOK description: The publisher(s) for which to fetch the conversation for - name: userId in: query required: true schema: type: string description: ID of the user to fetch the conversation for responses: '200': description: Get Conversation Response content: application/json: schema: title: GetConversationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: nextPageToken: $ref: '#/components/schemas/NextPageToken' deadline: type: string format: date description: | The latest time to which you can send a message to the user. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. user: type: object properties: id: type: string description: The ID of the user that you're having a conversation with name: type: string description: The name of the user that you're having a conversation with conversation: type: array items: $ref: '#/components/schemas/ConversationMessageWithParent' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/social/messages: get: operationId: listSocialMessages summary: 'Messages: List' tags: - Social description: | Fetches the latest message sent by a `user` on a `publisher` / `entityId`. To fetch the whole conversation for a specific `user` / `publisher` / `entityId`, provide the `user.id` that's returned in the response against the Conversation: Get endpoint. To send a message to a specific `user` / `publisher` / `entityId`, provide the `user.id` that's returned in the response against the Messages: Create endpoint. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/pageToken' - name: entityIds in: query required: false schema: type: array items: type: string description: Filters messages that match the specified entityId(s) - name: publishers in: query required: false schema: type: array items: type: string enum: - INSTAGRAM - FACEBOOK description: Filters messages that match specified publisher(s) - name: userName in: query required: false schema: type: string description: Filters messages that match the user name (Facebook name or Instagram handle) - name: messageText in: query required: false schema: type: string description: Filters messages that match the specified text - name: sortBy in: query required: false schema: type: array items: type: string enum: - OLDEST_TO_NEWEST - NEWEST_TO_OLDEST description: Defaults to `NEWEST_TO_OLDEST` - name: readUnreadStatus in: query required: false schema: type: array items: type: string enum: - READ - UNREAD description: Filters messages that match the specified readUnreadStatus - name: minCreatedDate in: query schema: type: string format: date description: | Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. - name: maxCreatedDate in: query schema: type: string format: date description: | Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. responses: '200': description: List Messages Response content: application/json: schema: title: ListMessagesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: nextPageToken: $ref: '#/components/schemas/NextPageToken' items: type: array items: $ref: '#/components/schemas/Message' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createSocialMessages summary: 'Messages: Create' tags: - Social description: | Sends a message to a specified `userId` \ `publisher` \ `entityId`. The `userId` can be retrieved from the Messages: List response. parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/pageToken' requestBody: required: true content: application/json: schema: type: object required: - entityId - publisher - userId - text properties: entityId: type: string description: ID of the entity to create a message for. publisher: type: string enum: - INSTAGRAM - FACEBOOK description: The publisher the message should be sent to. userId: type: string description: The publisher user ID that the message should be sent to. text: type: string description: | The copy to be sent as the message. Character limits vary per publisher. Please refer to the following character limits: Facebook: 2000 Instagram: 1000 responses: '200': description: Create Message Response content: application/json: schema: title: CreateMessageResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: message: $ref: '#/components/schemas/Message' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/roles: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getRoles tags: - Account Settings summary: 'Roles: Get' description: Retrieves a list of the roles that users can have within a customer’s account. responses: '200': $ref: '#/components/responses/RolesResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/users: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getUsers parameters: - $ref: '#/components/parameters/offset' tags: - Account Settings summary: 'Users: List' description: | Lists all Users in an account. **NOTE**: If the **`v`** parameter is before `20211115`: **`acl`** and **`externalIdentities`** will not be included in the response. This endpoint does not support the **`all`** macro. responses: '200': $ref: '#/components/responses/UsersResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createUser tags: - Account Settings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserRequest' summary: 'Users: Create' description: Create a new User responses: '201': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/users/{userId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/userId' get: operationId: getUser tags: - Account Settings summary: 'Users: Get' description: | Retrieves details of a specific User. **NOTE**: If the **`v`** parameter is before `20211115`: **`acl`** and **`externalIdentities`** will not be included in the response. responses: '200': $ref: '#/components/responses/UserResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updateUser tags: - Account Settings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateUserRequest' summary: 'Users: Update' description: Updates an existing User. responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteUser tags: - Account Settings summary: 'Users: Delete' description: Deletes an existing User. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/users/{userId}/password: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/userId' put: operationId: updateUserPassword tags: - Account Settings requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePasswordRequest' summary: 'Users: Update Password' description: Updates a User's password. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts: parameters: - $ref: '#/components/parameters/v' get: operationId: listAccounts parameters: - name: name in: query schema: type: string description: Returns only accounts whose name contains the provided string - name: limit in: query schema: type: integer maximum: 1000 default: 100 - $ref: '#/components/parameters/offset' tags: - Account Settings summary: 'Accounts: List' description: List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account. responses: '200': $ref: '#/components/responses/AccountsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getAccount tags: - Account Settings summary: 'Accounts: Get' description: Get details for an account responses: '200': $ref: '#/components/responses/AccountResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/approvalgroups: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getApprovalGroups tags: - Account Settings summary: 'Approval Groups: List' description: Lists all Approval Groups in the account. responses: '200': $ref: '#/components/responses/ApprovalGroupsResponse' default: $ref: '#/components/responses/ErrorResponse' post: operationId: createApprovalGroup tags: - Account Settings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateApprovalGroupRequest' summary: 'Approval Groups: Create' description: Creates an Approval Group. responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/approvalgroups/{approvalGroupId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/approvalGroupId' get: operationId: getApprovalGroup tags: - Account Settings summary: 'Approval Groups: Get' description: Gets a single Approval Group. responses: '200': $ref: '#/components/responses/ApprovalGroupResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updateApprovalGroup tags: - Account Settings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApprovalGroup' summary: 'Approval Groups: Update' description: | Updates a single Approval Group. **NOTE:** Despite using the PUT method, Approval Groups: Update only updates supplied fields. Omitted fields are not modified. However, the users list will be overwritten with what the user provides. responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteApprovalGroup tags: - Account Settings summary: 'Approval Groups: Delete' description: Deletes an Approval Group. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/linkedaccounts: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/linkedAccountsEntityIds' - $ref: '#/components/parameters/linkedAccountsPublisherIds' - $ref: '#/components/parameters/linkedAccountsStatuses' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/v' get: operationId: listLinkedAccounts tags: - Account Settings summary: 'LinkedAccounts: List' description: Lists all linked accounts in an account. responses: '200': $ref: '#/components/responses/LinkedAccountsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/linkedaccounts/{linkedAccountId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/linkedAccountId' - $ref: '#/components/parameters/v' get: operationId: getLinkedAccount tags: - Account Settings summary: 'LinkedAccounts: Get' description: Get details for an linked account. responses: '200': $ref: '#/components/responses/LinkedAccountResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/optimizationtasks: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getOptimizationTasks parameters: - $ref: '#/components/parameters/taskIds' - $ref: '#/components/parameters/taskLocationIds' tags: - Optimization Tasks summary: 'Optimization Tasks: List' description: List Optimization Tasks for the account, optionally filtered by task and location. responses: '200': $ref: '#/components/responses/OptimizationTasksResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/optimizationlink: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getLinkOptimizationTask parameters: - $ref: '#/components/parameters/taskIds' - $ref: '#/components/parameters/taskLocationId' - $ref: '#/components/parameters/mode' tags: - Optimization Tasks summary: 'Optimization Tasks: Get Link' description: Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location responses: '200': $ref: '#/components/responses/OptimizationLinkResponse' 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**." Valid values: * `markdown` * `html` * `none` 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.\n\n**NOTE:**\n* 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.\n* 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.\n" requestBody: $ref: '#/components/requestBodies/assetRequest' parameters: - schema: minLength: 0 type: string default: markdown description: | The formatting langauge used to parse rich text field values. Present if and only if type of field is "**Rich Text**." Valid values: * `markdown` * `html` 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**." Valid values: * `markdown` * `html` * `none` 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.\n\n**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.\n\n**NOTE:**\n* 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.\n* 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.\n" requestBody: $ref: '#/components/requestBodies/assetRequest' parameters: - schema: minLength: 0 type: string default: markdown description: | The formatting langauge used to parse rich text field values. Present if and only if type of field is "**Rich Text**." Valid values: * `markdown` * `html` 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}/connectors/{connectorId}/pushData: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: pushData requestBody: description: The data to be saved for and processed by the Connector. required: true content: text/plain: schema: type: string parameters: - name: connectorId in: path required: true schema: type: string description: ID of the Connector. - name: runMode in: query schema: type: string default: DEFAULT enum: - DEFAULT - COMPREHENSIVE - DELETION description: The run mode of the Connector. - name: dryRun in: query schema: type: boolean default: 'false' description: Whether the run should include a dry run. tags: - Connectors summary: 'Connectors: Push Data' description: | Pushes data to be saved for and processed by a specified Connector. A run will be initiated with the data provided. responses: '200': $ref: '#/components/responses/PushDataEndpointResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/connectors/{connectorId}/trigger: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: triggerConnector parameters: - name: connectorId in: path required: true schema: type: string description: ID of the Connector. - name: runMode in: query schema: type: string default: DEFAULT enum: - DEFAULT - COMPREHENSIVE - DELETION description: The run mode of the Connector. - name: dryRun in: query schema: type: boolean default: 'false' description: Whether the run should include a dry run. tags: - Connectors summary: 'Connectors: Trigger' description: Triggers a run of the specified Connector. responses: '200': $ref: '#/components/responses/TriggerConnectorResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/connectors/{connectorId}/runs/{runUid}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' get: operationId: getConnectorRun parameters: - name: connectorId in: path required: true schema: type: string description: ID of the Connector. - name: runUid in: path required: true schema: type: string description: UID of the Run. tags: - Connectors summary: 'Connectors: Get Run' description: Retrieve information for a Run with a given ID and Connector ID. responses: '200': $ref: '#/components/responses/GetConnectorRunResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/connectors/{connectorId}/runs/{runUid}/approve: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: approveRun parameters: - name: connectorId in: path required: true schema: type: string description: ID of the Connector. - name: runUid in: path schema: type: string description: UID of the run to be approved. tags: - Connectors summary: 'Connectors: Approve Run' description: | Approves a dry run that is ready for review. The changes from the dry run will be applied once the run is approved. responses: '200': $ref: '#/components/responses/ApproveRunResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/connectors/{connectorId}/runs/{runUid}/cancel: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: cancelRun parameters: - name: connectorId in: path required: true schema: type: string description: ID of the Connector. - name: runUid in: path schema: type: string description: UID of the run to be cancelled. tags: - Connectors summary: 'Connectors: Cancel Run' description: Cancels a non-terminal run. responses: '200': $ref: '#/components/responses/CancelRunResponse' 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. **NOTE:** * App must have **Create Suggestions: Read/Write** permission to utilize endpoint. * If a suggestion already exists from your app on the specified field, the suggestion will be updated. * Suggestions on ECLs are not currently supported. 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". This param value needs to be URL encoded. The following fields are supported for sorting: * uid * lastUpdatedDate required: false tags: - Knowledge Manager summary: 'Suggestions: List' description: | Retrieve a list of Suggestions within an account **NOTE:** * App must have either **Create Suggestions: Read** permission or **Manage Suggestions: Read** permission to utilize endpoint. * If App only has **Create Suggestions: Read** permission, only Suggestions created by the App in question will be returned. * Suggestions on ECLs are not supported. * 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. 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. **NOTE:** * App must have **Create Suggestions: Read/Write** permission to utilize endpoint. * Suggestions can only be canceled by the submitter. 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 **NOTE:** * App must have either **Create Suggestions: Read** permission or **Manage Suggestions: Read** permission to utilize endpoint. * If App only has **Create Suggestions: Read** permission, only Suggestions created by the App in question will be returned. * Suggestions on ECLs are not supported. * 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. 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. **NOTE:** * App must have **Manage Suggestions: Read/Write** permission to utilize endpoint. 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. This 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. **NOTE:** * App must have **Manage Suggestions: Read/Write** permission to utilize endpoint. * Only one of **`locked`**, **`assignee`**, **`status`**, or **`entityFieldSuggestion`** can be provided in the request. responses: '200': $ref: '#/components/responses/IdResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/config/resourcenames/{resourceGroup}/{resourceSubType}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/resourceGroup' - $ref: '#/components/parameters/resourceSubType' get: operationId: listResourceConfigNames tags: - Configuration summary: 'Resource Names: List' description: | Get a list of resource names for an account for a given resource type. `resourceGroup` and `resourceSubType` combine to describe the type of resource to query. Examples: `km/entity`, `platform/account-features`. responses: '200': $ref: '#/components/responses/ResourceNamesList' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/config/resources/{resourceGroup}/{resourceSubType}/{resourceId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/resourceGroup' - $ref: '#/components/parameters/resourceSubType' get: operationId: getResourceConfiguration tags: - Configuration summary: 'Resource Configuration: Get' description: | Get a resource configuration. `resourceGroup` and `resourceSubType` combine to describe the type of resource to return. Examples: `km/entity`, `platform/account-features`. `resourceId` describes the specific resource to return, matching the `$id` field of the resource configuration. To return the resource configuration of singleton resources (resources without `$id` fields like `km/settings` and `platform/account-features`), specify `config` as the `resourceId`. Example: `platform/account-features/config` responses: '200': $ref: '#/components/responses/Resource' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updateResourceConfig tags: - Configuration summary: 'Resource Configuration: Update' description: | Update a resource configuration. It overwrites the existing resource entirely. `resourceGroup` and `resourceSubType` combine to describe the type of resource to return. Examples: `km/entity`, `platform/account-features`. `resourceId` describes the specific resource to return, matching the `$id` field of the resource configuration. To update the resource configuration of singleton resources (resources without `$id` fields like `km/settings` and `platform/account-features`), specify `config` as the `resourceId`. Example: `platform/account-features/config` requestBody: content: application/json: schema: $ref: '#/components/schemas/Resource' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' patch: operationId: patchResourceConfig tags: - Configuration summary: 'Resource Configuration: Patch' description: | Patch a resource configuration. It only updates the provided attributes and keeps the existing attributes intact. `resourceGroup` and `resourceSubType` combine to describe the type of resource to return. Examples: `km/entity`, `platform/account-features`. `resourceId` describes the specific resource to return, matching the `$id` field of the resource configuration. To patch the resource configuration of singleton resources (resources without `$id` fields like `km/settings` and `platform/account-features`), specify `config` as the `resourceId`. Example: `platform/account-features/config` requestBody: content: application/json: schema: $ref: '#/components/schemas/Resource' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/config/resources/{resourceGroup}/{resourceSubType}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/resourceGroup' - $ref: '#/components/parameters/resourceSubType' post: operationId: createResourceConfig tags: - Configuration summary: 'Resource Configuration: Create' description: | Create a new resource for a given resource type. `resourceGroup` and `resourceSubType` combine to describe the type of resource to create. Examples: `km/entity`, `platform/account-features`. requestBody: content: application/json: schema: $ref: '#/components/schemas/Resource' responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/license-packs/{licensePackId}/assigned-entities/{entityId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/licensePackId' - $ref: '#/components/parameters/entityId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: | All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. required: true post: operationId: createLicenseAssignment tags: - Licenses summary: | License Assignment: Create description: This is used to assign a license to an entity. responses: '200': $ref: '#/components/responses/LicenseAssignment' default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteLicenseAssignment tags: - Licenses summary: | License Assignment: Delete description: This is used to immediately remove a license from an entity. responses: '200': $ref: '#/components/responses/EmptyResponse' default: $ref: '#/components/responses/ErrorResponse' put: operationId: updateLicenseAssignment tags: - Licenses summary: | License Assignment: Update description: This is used to schedule future removal of a license from an entity by specifying an expiration date. A user can also omit an expiration date or specify an expiration date of null, which would cancel that future removal. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLicenseAssignmentRequestBody' responses: '200': $ref: '#/components/responses/LicenseAssignment' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/license-packs: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: | All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. required: true - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/pageToken' get: operationId: listLicensePacks tags: - Licenses summary: | License Packs: List description: | This is used to list all active license packs on the account. responses: '200': $ref: '#/components/responses/LicensePacks' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/license-packs/{licensePackId}/assigned-entities: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/licensePackId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: | All requests must be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. required: true - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/assignedEntity' get: operationId: listLicenseAssignments tags: - Licenses summary: | License Assignments: List description: | This is used to list all licenses that have been assigned to an entity. Users can specify all license packs using a wildcard "-" as the licensePackId, which allows them to request all license assignments for that entity. responses: '200': $ref: '#/components/responses/LicenseAssignments' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/computations: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - name: api_key in: query schema: type: string description: | All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. required: true post: operationId: createOperation requestBody: description: The computation operation to be created. required: true content: application/json: schema: $ref: '#/components/schemas/CreateOperationRequest' tags: - Computations summary: 'Computations: Create Operation' description: | Creates a single computation operation. responses: '200': $ref: '#/components/responses/OperationResponse' default: $ref: '#/components/responses/ErrorResponse' get: operationId: listOperations parameters: - name: pageSize in: query schema: type: string description: | Max Page Size = 1000 and unspecified defaults to 100. - 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. tags: - Computations summary: 'Computations: List Operations' description: | Retrieve a list of computation operations. responses: '200': $ref: '#/components/responses/ListOperationsResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/computations/{operationUid}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/computationOperationUid' - name: api_key in: query schema: type: string description: | All requests will be authenticated using an app's API key via the api_key query parameter. You can find this value in Developer Console / [App Name] / API Credentials. required: true post: operationId: cancelOperation tags: - Computations summary: 'Computations: Cancel Operation' description: | Cancels a computation operation. responses: '200': description: OK default: $ref: '#/components/responses/ErrorResponse' get: operationId: getOperation tags: - Computations summary: 'Computations: Get Operation' description: | Retrieve a single computation operation. responses: '200': $ref: '#/components/responses/OperationResponse' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/domains: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: createDomain tags: - Domains summary: | Domain: Create requestBody: description: Configuration for the domain to be created. required: true content: application/json: schema: type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true required: - hostname - destination - integration_type responses: '201': description: Domain created successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' get: operationId: listDomains tags: - Domains summary: | Domain: List parameters: - $ref: '#/components/parameters/hostnameFilters' - $ref: '#/components/parameters/hostnameSearchFilter' - $ref: '#/components/parameters/showDeleted' - $ref: '#/components/parameters/index_pageSize' - $ref: '#/components/parameters/index_pageToken' - $ref: '#/components/parameters/viewDefaultBasic' responses: '200': description: Paginated list of Domains matching request filters. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: domains: type: array items: title: Domain type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true next_page_token: $ref: '#/components/schemas/nextPageToken' previous_page_token: $ref: '#/components/schemas/previousPageToken' total_size: $ref: '#/components/schemas/totalSize' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/domains/{domainId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/domainId' get: operationId: getDomain tags: - Domains summary: | Domain: Get parameters: - $ref: '#/components/parameters/viewDefaultFull' responses: '200': description: Domain found. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' patch: operationId: updateDomain tags: - Domains summary: | Domain: Update description: | Update the configurations for the specified domain. Also triggers a check for Yext or SSL verification, if the Domain is not yet ACTIVE. See the `update_mask` parameter for fields that can be updated, any other provided fields will be ignored. parameters: - $ref: '#/components/parameters/forceMove' - name: update_mask in: query schema: type: array default: '*' items: type: string enum: - '*' - managed_ssl.certificate_authority - custom_ssl_certificate - managed_csr.custom_public_certificate description: A comma-separated list of fields to update. requestBody: content: application/json: schema: type: object properties: managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority properties: certificate_authority: $ref: '#/components/schemas/certificate_authority' managed_csr: $ref: '#/components/schemas/managed_csr' custom_ssl_certificate: $ref: '#/components/schemas/custom_ssl_certificate' responses: '200': description: Domain updated successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteDomain tags: - Domains summary: | Domain: Delete parameters: - name: force in: query schema: type: boolean default: false description: | If true, Domain Associations using this domain will also be deleted. If not set or false, and if Domain Associations exist using this domain, an error will be returned. responses: '202': description: Domain deleted successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/domains/migratepagesdomain/{hostname}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: migratePagesDomain tags: - Domains summary: Migrate Legacy Pages Domain description: Migrates a legacy Pages domain to a Domains API domain resource. parameters: - name: hostname in: path required: true schema: type: string description: The hostname of the legacy domain to migrate. responses: '201': description: Legacy domain migrated to Domains API successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: domains: description: | [Domain](#tag/Domains/operation/createDomain) resources created as a result of the migration. type: array items: title: Domain type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: Fully qualified domain name that will be delegated to Yext. type: string example: www.example.com wildcard: description: | If set to true, [Domain Associations](#tag/Domains/operation/createDomainAssociation) can be created for single-level subdomains of the given hostname. type: boolean default: false destination: description: | The Yext product the domain will be used for. Currently, only `PAGES` is supported. type: string enum: - PAGES example: PAGES integration_type: description: | How the domain will be integrated with Yext. Only `USER_OWNED` is supported for domains created via the API. type: string enum: - USER_OWNED - CUSTOM - LEGACY_YEXT_MANAGED example: USER_OWNED state: type: string readOnly: true enum: - PENDING_VERIFICATION - VERIFICATION_FAILED - PENDING_CREATION - CREATING - CREATION_FAILED - ACTIVE - PENDING_DELETION - DELETED - BLOCKED - DELETION_FAILED - MOVE_REQUIRED example: ACTIVE ownership_verification: description: | One of CNAME, TXT, or HTTP verification must be used to complete Yext ownership verification for the domain. The tokens to use for each of these methods are provided in this object. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid managed_ssl: description: | SSL certificate will be automatically managed by Yext. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - certificate_authority - validation_method properties: certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST validation_method: type: string enum: - HTTP - TXT example: HTTP hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid http_validation: description: | This will only be set if `HTTP` is selected via the `validation_method` field. type: object readOnly: true properties: uri: type: string example: http://www.example.com/.well-known/acme-challenge/0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr body: type: string example: 0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI txt_validation: description: | This will only be set if `TXT` is selected via the `validation_method` field. The delegated DCV CNAME is recommended over the individual TXT records,since delegated DCV would only need to be done one time, whereas the individual TXT records would have to be set everytime the certificate is renewed. type: object readOnly: true properties: delegated_dcv_domain: type: string delegated_dcv_cname_target: type: string txt_records: description: | Will have multiple required tokens if the domain is a wildcard domain. type: array items: type: object properties: domain: type: string example: _acme-challenge.www.example.com value: type: string example: '-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos' managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid serving_dns_targets: description: | DNS targets used to serve traffic through Yext. For apex domains, `a_records` is returned. For subdomains, `cname` is returned. Only one of `a_records` or `cname` will be set. type: object readOnly: true properties: a_records: description: | Expected A record targets to serve traffic. Returned for apex domains. type: array items: type: string example: - 104.17.134.18 cname: description: | Expected CNAME target to serve traffic. Returned for subdomains. type: string example: 93bpo083jheeb.yext.pagescdn.com errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true delete_time: type: string format: date-time readOnly: true domain_associations: description: | [Domain Associations](#tag/Domains/operation/createDomainAssociation) resources created as a result of the migration. type: array items: title: Domain Association type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/domains/{domainId}/associations: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/domainId' post: operationId: createDomainAssociation tags: - Domains summary: | Domain Association: Create description: | Creating a Domain Association will begin serving the contents of the associated resource at the Domain Association's `hostname` (given DNS for the hostname is already set up). parameters: - $ref: '#/components/parameters/forceMove' requestBody: required: true content: application/json: schema: type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true responses: '201': description: Domain Association created successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain Association type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' get: operationId: listDomainAssociations tags: - Domains summary: | Domain Association: List parameters: - $ref: '#/components/parameters/domainIdAllowAll' - name: referenced_resources in: query schema: type: array items: type: string description: Comma-separated list of associated resources to filter by. example: accounts/123456/sites/6789,accounts/98765/sites/5678 - $ref: '#/components/parameters/index_pageSize' - $ref: '#/components/parameters/index_pageToken' responses: '200': description: Paginated list of Domains Associations matching request filters. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: domain_associations: type: array items: title: Domain Association type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true next_page_token: $ref: '#/components/schemas/nextPageToken' previous_page_token: $ref: '#/components/schemas/previousPageToken' total_size: $ref: '#/components/schemas/totalSize' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/domains/{domainId}/associations/{domainAssociationId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/domainId' - $ref: '#/components/parameters/domainAssociationId' get: operationId: getDomainAssociation tags: - Domains summary: | Domain Association: Get responses: '200': description: Domain Association found. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain Association type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' patch: operationId: updateDomainAssociation tags: - Domains summary: | Domain Association: Update parameters: - $ref: '#/components/parameters/domainId' - $ref: '#/components/parameters/domainAssociationId' requestBody: content: application/json: schema: type: object properties: site: $ref: '#/components/schemas/site' responses: '201': description: Domain Association updated successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Domain Association type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 hostname: description: | For parent Domain's with `wildcard=false`, this will equal parent Domain's hostname. For parent Domain's with `wildcard=true`, this can be a single-level subdomain of the parent Domain's hostname. type: string example: www.example.com site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false errors: description: Errors and/or warnings regarding the Domain setup. type: array readOnly: true items: $ref: '#/components/schemas/ResponseError' create_time: type: string format: date-time readOnly: true update_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteDomainAssociation tags: - Domains summary: | Domain Association: Delete description: | Deleting a Domain Association will stop serving the contents of the associated resource from the Domain Association's `hostname`. responses: '202': description: Domain Association deleted successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/csrs: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' post: operationId: createManagedCsr tags: - Domains summary: | Managed CSR: Create description: | Creates a Certificate Signing Request (CSR) resource that can be used to provision SSL certificates. Once created, this resource can be referenced by [Domains](#tag/Domains/operation/createDomain) with the `managed_csr` SSL integration to provision certificates using this CSR and a public certificate. requestBody: required: true content: application/json: schema: type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 csr_payload: type: object properties: common_name: description: Fully qualified domain name. type: string example: www.example.com sans: description: Subject Alternative Names. type: array items: type: string example: - test.example.com - other.example.net organization: type: string example: Example Inc. organizational_unit: type: string example: IT Department key_type: type: string enum: - rsa2048 - p256v1 locality: type: string example: San Francisco state: type: string example: California country: type: string example: US csr: description: The generated Certificate Signing Request. type: string readOnly: true example: | -----BEGIN CERTIFICATE REQUEST----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE REQUEST----- created_time: type: string format: date-time readOnly: true required: - csr_payload - csr responses: '201': description: Managed CSR created successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Managed CSR type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 csr_payload: type: object properties: common_name: description: Fully qualified domain name. type: string example: www.example.com sans: description: Subject Alternative Names. type: array items: type: string example: - test.example.com - other.example.net organization: type: string example: Example Inc. organizational_unit: type: string example: IT Department key_type: type: string enum: - rsa2048 - p256v1 locality: type: string example: San Francisco state: type: string example: California country: type: string example: US csr: description: The generated Certificate Signing Request. type: string readOnly: true example: | -----BEGIN CERTIFICATE REQUEST----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE REQUEST----- created_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' get: operationId: listManagedCsrs tags: - Domains summary: | Managed CSR: List parameters: - $ref: '#/components/parameters/index_pageSize' - $ref: '#/components/parameters/index_pageToken' - $ref: '#/components/parameters/viewDefaultBasic' responses: '200': description: Paginated list of Managed CSRs. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: managed_csrs: type: array items: title: Managed CSR type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 csr_payload: type: object properties: common_name: description: Fully qualified domain name. type: string example: www.example.com sans: description: Subject Alternative Names. type: array items: type: string example: - test.example.com - other.example.net organization: type: string example: Example Inc. organizational_unit: type: string example: IT Department key_type: type: string enum: - rsa2048 - p256v1 locality: type: string example: San Francisco state: type: string example: California country: type: string example: US csr: description: The generated Certificate Signing Request. type: string readOnly: true example: | -----BEGIN CERTIFICATE REQUEST----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE REQUEST----- created_time: type: string format: date-time readOnly: true next_page_token: $ref: '#/components/schemas/nextPageToken' previous_page_token: $ref: '#/components/schemas/previousPageToken' total_size: $ref: '#/components/schemas/totalSize' default: $ref: '#/components/responses/ErrorResponse' /accounts/{accountId}/csrs/{managedCsrId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/v' - $ref: '#/components/parameters/managedCsrId' get: operationId: getManagedCsr tags: - Domains summary: | Managed CSR: Get parameters: - $ref: '#/components/parameters/viewDefaultFull' responses: '200': description: Managed CSR found. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: title: Managed CSR type: object properties: name: description: Identifier for the resource. type: string readOnly: true example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 csr_payload: type: object properties: common_name: description: Fully qualified domain name. type: string example: www.example.com sans: description: Subject Alternative Names. type: array items: type: string example: - test.example.com - other.example.net organization: type: string example: Example Inc. organizational_unit: type: string example: IT Department key_type: type: string enum: - rsa2048 - p256v1 locality: type: string example: San Francisco state: type: string example: California country: type: string example: US csr: description: The generated Certificate Signing Request. type: string readOnly: true example: | -----BEGIN CERTIFICATE REQUEST----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE REQUEST----- created_time: type: string format: date-time readOnly: true default: $ref: '#/components/responses/ErrorResponse' delete: operationId: deleteManagedCsr tags: - Domains summary: | Managed CSR: Delete responses: '202': description: Managed CSR deleted successfully. content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' default: $ref: '#/components/responses/ErrorResponse' components: securitySchemes: api_key: type: apiKey name: api_key in: query api-key: type: apiKey name: api-key in: header schemas: 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 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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 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 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"` FinancialProfessionalWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: 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. 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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. 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 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 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`) 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 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. 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. 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 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 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 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 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. 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 youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. 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 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. 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 HelpArticleWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup 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 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"` 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. 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 HotelRoomTypeWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: name: minLength: 0 maxLength: 5000 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. 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 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"` 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 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. 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. 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 OrganizationWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: name: minLength: 0 maxLength: 5000 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 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. 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 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 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 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. instagramHandle: minLength: 0 maxLength: 30 type: string description: Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) 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. linkedInUrl: minLength: 0 format: uri type: string description: URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername 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. nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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: The list of countries the business operates in 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 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 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 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"` 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. 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 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 youTubeChannelUrl: minLength: 0 format: uri type: string description: URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername ProductWrite: allOf: - $ref: '#/components/schemas/EntityWrite' - additionalProperties: false type: object properties: name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup 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 nudgeEnabled: type: boolean description: Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity 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 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"` 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 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. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup 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: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. 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 ResponseMeta: type: object properties: uuid: type: string example: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 description: Unique ID for this request / response. ResponseError: type: object properties: name: type: string code: type: integer description: | Code that uniquely identifies the error or warning. type: type: string enum: - FATAL_ERROR - NON_FATAL_ERROR - WARNING message: type: string description: Message explaining the problem. ResponseMetaWithError: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: errors: type: array description: List of errors and warnings. items: $ref: '#/components/schemas/ResponseError' 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. LocationType: type: string enum: - LOCATION - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - RESTAURANT - ATM 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. Location: type: object properties: id: type: string maxLength: 50 description: Primary key. Unique alphanumeric (Latin-1) ID assigned by the Customer. uid: type: string readOnly: true description: A static globally unique id for the location. Note that this field cannot be used in place of the location id in API calls to get or update location information. accountId: type: string maxLength: 50 description: Must refer to an **account.id** that already exists. timestamp: type: integer format: int64 readOnly: true description: | The timestamp of the most recent change to this location record. Will be ignored when the client is saving location data to Yext. **NOTE:** The timestamp may change even if observable fields stay the same. timezone: readOnly: true description: | The timezone of the location minLength: 0 type: string locationType: $ref: '#/components/schemas/LocationType' locationName: type: string maxLength: 100 description: | Cannot include: * inappropriate language * HTML markup or entities * a URL or domain name * a phone number * control characters ([\x00-\x1F\x7F]) Should be in appropriate letter case (e.g., not in all capital letters) firstName: type: string description: | The first name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. middleName: type: string description: | The middle name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. lastName: type: string description: | The last name of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. officeName: type: string description: | The name of the office where the healthcare professional works, if different from **locationName** **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. gender: type: string description: | The gender of the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. enum: - FEMALE - F - MALE - M - UNSPECIFIED npi: type: string description: | The National Provider Identifier (NPI) of the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. address: type: string maxLength: 255 description: | Must be a valid address Cannot be a P.O. Box address2: type: string maxLength: 255 description: Cannot be a P.O. Box suppressAddress: type: boolean description: If true, do not show street address on listings. Defaults to false. displayAddress: type: string maxLength: 255 description: | Provides additional information to help consumers get to the location. This string appears along with the location's address (e.g., In Menlo Mall, 3rd Floor). It may also be used in conjunction with a hidden address (i.e., when **suppressAddress** is true) to give consumers information about where the location is found (e.g., Servicing the New York area). Cannot be a P.O. Box city: type: string maxLength: 80 state: type: string maxLength: 80 description: | For US locations, the two-character code of the location’s state, or DC for the District of Columbia For non-US locations, the name of the location’s province / region / state sublocality: type: string maxLength: 255 description: The name of the location's sublocality. zip: type: string maxLength: 10 description: The location's postal code. For US locations, this field contains the five- or nine-digit ZIP code (the hyphen is optional). countryCode: type: string maxLength: 2 description: The two-character ISO 3166-1 code of the location's country or region. If omitted, US is used. serviceArea: type: object properties: radius: type: number format: double description: | The distance around the location that the business serves **NOTE:** This field is no longer supported by Google Business Profile and is deprecated. We no longer accept or store values for **`radius`**. unit: type: string description: | The unit in which radius is measured. **NOTE:** This field is no longer supported by Google Business Profile and is deprecated. We no longer accept or store values for **`units`**. places: type: array items: type: string description: | A list of places served by the location, where each place is either: * a postal code, or * the name of a city. description: | Area that is served by this location. It may be specified as a radius from the location's address or as a list of cities and/or postal codes. **Only for Google Business Profile:** Currently, **serviceArea** is only supported by Google Business Profile and will not affect your listings on other sites. phone: type: string description: Must be a valid phone number. isPhoneTracked: type: boolean description: | Set to true if the number listed in **phone** is a tracked phone number. **NOTE:** When updating **isPhoneTracked**, you must provide a value for **phone** in the same request. localPhone: type: string description: | Must be a valid, non-toll-free phone number. Required if: * **isPhoneTracked** is true and the non-tracked number is a toll-free number, **OR** * **isPhoneTracked** is false and **phone** is a toll-free number alternatePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. faxPhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. mobilePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. tollFreePhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. ttyPhone: type: string description: Must be a valid phone number, based on the country specified in `countryCode`. Phone numbers for US locations must contain 10 digits. categoryIds: type: array items: type: string description: | Yext Category IDs. A Location must have at least one and at most 10 Categories. IDs must be valid and selectable (i.e., cannot be parent categories). **NOTE:** The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. featuredMessage: type: string maxLength: 50 description: | The Featured Message. Default: Call today! Cannot include: * inappropriate language * HTML markup * a URL or domain name * a phone number * control characters ([\x00-\x1F\x7F]) * insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. featuredMessageUrl: type: string maxLength: 255 description: Valid URL to which the Featured Message is linked websiteUrl: type: string maxLength: 255 description: | The URL of the location's website. This URL will be shown on your listings unless you specify a value for `displayWebsiteUrl`. Must be a valid URL and is required whenever `displayWebsiteUrl` is specified. displayWebsiteUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `websiteUrl`. You can use `displayWebsiteUrl` to display a short, memorable web address that redirects consumers to the URL given in `websiteUrl`. Must be a valid URL and be specified along with `websiteUrl`. reservationUrl: type: string maxLength: 255 description: A valid URL used for reservations at this location. displayReservationUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `reservationUrl`. You can use `displayReservationUrl` to display a short, memorable web address that redirects consumers to the URL given in `reservationUrl`. Must be a valid URL and be specified along with `reservationUrl`. menuUrl: type: string maxLength: 255 description: The URL of the location's menu. displayMenuUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `menuUrl`. You can use `displayMenuUrl` to display a short, memorable web address that redirects consumers to the URL given in `menuUrl`. Must be a valid URL and be specified along with `menuUrl`. orderUrl: type: string maxLength: 255 description: The URL used to place orders that will be fulfilled at the location. displayOrderUrl: type: string maxLength: 255 description: | The URL that is shown on your listings in place of `orderUrl`. You can use `displayOrderUrl` to display a short, memorable web address that redirects consumers to the URL given in `orderUrl`. Must be a valid URL and be specified along with `orderUrl`. hours: type: string maxLength: 255 description: | Hours should be submitted as a comma-separated list of days, where each day's hours are specified as follows: d:oh:om:ch:cm * d = day of the week – * 1 – Sunday * 2 – Monday * 3 – Tuesday * 4 – Wednesday * 5 – Thursday * 6 – Friday * 7 – Saturday * oh:om = opening time in 24-hour format * ch:cm = closing time in 24-hour format Times with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00). **Example:** open 9 AM to 5 PM Monday and Tuesday, open 10 AM to 4 PM on Saturday – 2:9:00:17:00,3:9:00:17:00,7:10:00:16:00 SPECIAL CASES: * To indicate that a location is open 24 hours on a specific day, set 00:00 as both the opening and closing time for that day. * **Example:** open all day on Saturdays – 7:00:00:00:00 * To indicate that a location is closed on a specific day, omit that day from the list or set it as closed ("closed" is not case sensitive). * **Example:** closed on Sundays – 1:closed * **NOTE:** If a location is closed seven days a week, set at least one day to closed. Otherwise, **hours** is an empty string, and we assume you are not submitting hours information for that location. * To indicate that a location has split hours on a specific day, submit a set of hours for each block of time the location is open. * **Example:** open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM on Mondays – 2:9:00:12:00,2:13:00:17:00 **NOTE:** To set hours for specific days of the year rather than days of the week, use **holidayHours**. additionalHoursText: type: string maxLength: 255 description: Additional information about business hours that does not fit in **hours** (e.g., Closed during the winter) holidayHours: type: array items: type: object properties: hours: type: string description: | Special opening and closing times in 24-hour format (OH:OM:CH:CM, where OH:OM is the opening time and CH:CM is the closing time). Times with single-digit hours (e.g., 9 AM) can be submitted with or without a leading zero (9:00 or 09:00). Examples: * 9:00:15:00 — Opening at 9:00 AM, closing at 3:00 PM * "" (empty string) — Closed all day * 0:00:0:00 or 0:00:23:59 — Open 24 hours * 9:00:15:00,17:00:19:00 — Split hours: open from 9:00 AM to 3:00 PM and again from 5:00 PM to 7:00 PM **NOTE:** If **isRegularHours** is set to true, we will ignore this field. date: type: string format: date description: The date on which the holiday hours will be in effect isRegularHours: type: boolean default: false description: Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. description: | Holiday hours for this location. **NOTE:** hours must be set in order for holidayHours to appear on your listings) description: type: string minLength: 10 maxLength: 5000 conditionsTreated: type: array items: type: string description: | A list of the conditions treated by the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. certifications: type: array items: type: string description: | A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. educationList: type: array items: type: object properties: type: type: string description: The kind of education or training completed enum: - FELLOWSHIP - INTERNSHIP - MEDICAL_SCHOOL - RESIDENCY institutionName: type: string description: The name of the institution where the healthcare professional received the education or training yearCompleted: type: string description: The year the healthcare professional completed the education or training description: | A list of the types of education and training completed by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. degrees: type: array items: type: string description: | A list of the degrees earned by the healthcare professional **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. Valid values: * `ANP` (Adult Nurse Practitioner) * `APN` (Advanced Practice Nurse) * `APRN` (Advanced Practice Registered Nurse) * `ARNP` (Advanced Registered Nurse Practitioner) * `CNM` (Certified Nurse Midwife) * `CNP` (Certified Nurse Practitioner) * `CNS` (Clinical Nurse Specialist) * `CPNP` (Certified Pediatric Nurse Practitioner) * `CRNA` (Certified Registered Nurse Anesthetist) * `CRNP` (Certified Registered Nurse Practitioner) * `DC` (Doctor of Chiropractic) * `DDS` (Doctor of Dental Surgery) * `DMD` (Doctor of Dental Medicine) * `DO` (Doctor of Osteopathy) * `DPM` (Doctor of Podiatric Medicine) * `DVM` (Doctor of Veterinary Medicine) * `FNP` (Family Nurse Practitioner) * `GNP` (Geriatric Nurse Practitioner) * `LAC` (Licensed Acupuncturist) * `LPN` (Licensed Practical Nurse) * `MD` (Medical Doctor) * `ND` (Naturopathic Doctor) * `NP` (Nurse Practitioner) * `OD` (Doctor of Optometry) * `PA` (Physician Assistant) * `PAC` (Physician Assistant Certified) * `PHARMD` (Doctor of Pharmacy) * `PHD` (Doctor of Philosophy) * `PNP` (Pediatric Nurse Practitioner) * `VMD` (Veterinary Medical Doctor) * `WHNP` (Womens Health Nurse Practitioner) admittingHospitals: type: array items: type: string description: | A list of hospitals where the healthcare professional admits patients **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. acceptingNewPatients: type: boolean description: | Indicates whether the healthcare provider is accepting new patients Default is true **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL` or `HEALTHCARE_FACILITY`. closed: type: object properties: isClosed: type: boolean description: Indicates whether the location is closed description: | A set of field-value pairs indicating whether the location is closed and, if it is closed, the date of its closing. **NOTE:** This field does not appear in the GET response unless it has been explicitly set in a PUT request. paymentOptions: type: array items: type: string description: | The payment methods accepted at this location Valid elements depend on the location's country. For US locations, valid elements are: * AMERICANEXPRESS * CASH * CHECK * DINERSCLUB * DISCOVER * FINANCING * INVOICE * MASTERCARD * TRAVELERSCHECK * VISA * ANDROIDPAY * APPLEPAY * SAMSUNGPAY * BITCOIN * PAYPAL insuranceAccepted: type: array items: type: string description: | A list of insurance policies accepted by the healthcare provider **NOTE:** This field is only available to locations whose **`locationType`** is `HEALTHCARE_PROFESSIONAL`. logo: $ref: '#/components/schemas/Photo' 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. To retrieve a list of custom fields for your account, use the Custom Fields: List endpoint. If a field's **`type`** is `SINGLE_OPTION` or `MULTI_OPTION`, the option or options that apply to this location must be represented by their **`key`**s. Examples of each type of custom field: * BOOLEAN: * `{ "9662": "true" }` * DAILY_TIMES: * `{ "10012": { "dailyTimes": "2:7:00,3:7:00,4:7:00,5:7:00,6:7:00,7:7:00,1:7:00" } }` * DATE: * `{ "7066": "2016-10-12" }` * GALLERY: * `{ "7070": [ { "url": "http://a.mktgcdn.com/p/ounkg7aq6Oy029-sRf4CIH64/128x128.jpg" }, { "url": "http://a.mktgcdn.com/p/YkQGqxK8jFBqOlailQ9QIBsgs/1.0000/316x316.png" } ] }` * HOURS: * `{ "10011": { "hours": "1:7:00:20:00,2:7:00:20:00,3:7:00:20:00,4:7:00:20:00,5:7:00:20:00,6:7:00:20:00,7:7:00:20:00", "additionalHoursText": "Also by appointment" }` * LOCATION_LIST: * `{ "8098" : [ "locationId1", "locationId2" ] }` * MULTILINE_TEXT (up to 4,000 characters): * `{ "1592": "Take Route 13 south. Pass Riverrun Reservoir. At the traffic light before the post office, turn right off of Route 13. Pass the library and community center on your right and then pass a diner on your left. Cross over the bridge and at the third intersection, turn left onto Jones Street. We are located on the right side in the middle of the block." }` * MULTI_OPTION: * `{ "7068": ["2614", "2615"] }` (`"2614"` and `"2615"` are the options' **`key`**s) * NUMBER: * `{ "7078": "123" }` * PHOTO: * `{ "7071": { "url": "http://a.mktgcdn.com/p/bRtQXQZP2kEzgy2C8/800x800.jpg", "description": "New storefront", "details": "A picture of the new storefront" } }` * `{ "7071": null }` (This setting will clear the existing value of the Photo custom field.) * SINGLE_OPTION: * `{ "7069": "2617" }` (`"2617"` is the option's **`key`**) * TEXT (up to 255 characters): * `{ "6157": "Buy One, Get One 50% Off" }` * TEXT_LIST: * `{ "7072": [ "Item 1", "Item 2", "Item 3" ] }` * URL: * `{ "9381": "http://www.location.example.com" }` * VIDEO: * `{ "7077": { "url": "http://www.youtube.com/watch?v=6KQPho" } }` * VIDEO_GALLERY: * `{ "8452": [ { "url": "http://www.youtube.com/watch?v=B1EC1U" }, { "url": "http://www.youtube.com/watch?v=SkEtnN" } ] }` intelligentSearchTrackingEnabled: type: boolean description: | Indicates whether Intelligent Search Tracker is enabled. The Intelligent Search Tracker allows you to understand your performance in local search. intelligentSearchTrackingFrequency: type: string enum: - WEEKLY - MONTHLY - QUARTERLY description: | How often we send search queries to track your search performance. locationKeywords: type: array items: type: string enum: - NAME - PRIMARY_CATEGORY description: | Keywords that we will use to track your search performance. These keywords are based on the location information you've stored in our system. customKeywords: type: array items: type: string description: | Additional keywords you would like us to use when tracking your search performance queryTemplates: type: array items: type: string enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE description: | The ways in which your keywords will be arranged in the search queries we use to track your performance alternateNames: type: array items: type: string description: | Other names for your business that you would like us to use when tracking your search performance alternateWebsites: type: array items: type: string description: | Other websites for your business that we should look for when tracking your search performance competitors: type: array items: type: object properties: name: type: string description: The competitor's name website: type: string description: The competitor's website. description: | The names and websites of the competitors whose search performance you would like to compare to your own trackingSites: type: array items: type: string enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE description: | The search engines that we will use to track your performance isoRegionCode: type: string readOnly: true description: | The ISO 3166-2 region code for the location. Yext will determine the location’s code and update isoRegionCode with that value. If Yext is unable to determine the code for the location, the location’s ISO 3166-1 alpha-2 country code will be used. reviewBalancingURL: type: string maxLength: 255 readOnly: true description: | Link to the balancing URL that will auto-direct consumers to certain sites to leave reviews, based on review-generation settings firstPartyReviewPage: type: string maxLength: 255 readOnly: true description: | Link to the review-collection page, where consumers can leave first-party reviews isClusterPrimary: type: boolean description: | Indicates whether the location is the primary location in its group schemaTypes: type: array readOnly: true items: type: string description: | List of Schema Types for this location, based on its categories attire: type: string enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL description: | The formality of clothing typically worn at this location **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. priceRange: type: string enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR description: | The typical price of products sold at this location, on a scale of 1 (low) to 4 (high) **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. mealsServed: type: array items: type: string description: | Types of meals served at this location **NOTE:** This field is only available to locations whose **`locationType`** is `RESTAURANT`. Valid values: * `BREAKFAST` * `LUNCH` * `BRUNCH` * `HAPPY_HOUR` * `LATE_NIGHT` locatedIn: type: string description: | For ATMs, the external ID of the location that the ATM is installed in. The location must be in the same business account as the ATM. **NOTE:** This field is only available to locations whose **`locationType`** is `ATM`. primaryContact: type: string description: | ID of the user who is the primary Knowledge Assistant contact for the entity reviewResponseConversationEnabled: type: boolean description: | Indicates whether or not review response conversations are enabled for the Yext Knowledge Assistant holidayHoursConfirmationEnabled: type: boolean description: | Indicates whether or not holiday hour confirmation alerts are enabled for the Yext Knowledge Assistant 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. BaseEcl: type: object properties: id: type: string maxLength: 32 description: List ID. accountId: type: string readOnly: true description: ID of account that owns this List. name: type: string description: List name. title: type: string description: List title that appears on listings. size: type: integer readOnly: true description: Number of items in the List. publish: type: boolean description: Indicates whether the List should be shown on your listings. language: type: string description: | List language in ISO 639-1 format. An ISO 3166-1 alpha-2 country code can optionally be appended to the language. **Examples:** en, en_GB, fr_CA BaseEclSection: type: object properties: id: type: string description: Section ID. name: type: string description: Section name. description: type: string description: Section description. BaseEclItem: type: object properties: id: type: string description: Item ID. name: type: string description: Item name. description: type: string description: Item description. 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. Calories: type: object properties: type: type: string enum: - FIXED - RANGE calorie: type: integer description: Calorie count. Must be greater than or equal to 0 and less than or equal to 1000000. rangeTo: type: integer description: Specified only if `name` is `RANGE`. In that case, this Calories represents a calorie count range from `calorie` to `rangeTo`. Must be greater than `calorie` and less than or equal to 1000000. ContentListCostOption: type: object properties: name: type: string description: e.g., Small, Medium, Large, Add Bacon. price: type: string description: A simple price in USD, e.g., 1.00. calorie: type: integer description: How many calories this option adds. This field is for Menu items only. ContentListCost: type: object properties: type: type: string enum: - PRICE - RANGE - NONE - OTHER price: type: string description: Price in USD, e.g., 9.50. Must be greater than or equal to 0.0 and less than or equal to 1000000.00. unit: type: string description: e.g., Per Gallon, Each. rangeTo: type: string description: Specified only if `type` is `RANGE`. In that case, this Cost represents a `price` range from `price` to `rangeTo`. Must be greater than `price` and less than or equal to 1000000.00. other: type: string description: Specified only if `type` is `OTHER`. User-entered text, e.g., Market Price. options: type: array description: Add-ons or product variations that affect the price. items: $ref: '#/components/schemas/ContentListCostOption' MenuItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/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 Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/MenuItem' Menu: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: currency: type: string description: The three-letter ISO 4217 currency code. Defaults to USD. sourceUrl: type: string description: The URL of the source the menu's content is retrieved from. sections: type: array description: A list of sections. items: $ref: '#/components/schemas/Section' BioItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photo: $ref: '#/components/schemas/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. BioEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/BioItem' Bio: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: sections: type: array description: A list of sections. items: $ref: '#/components/schemas/BioEcl_Section' Photos: type: array description: List of up to 5 photos. items: $ref: '#/components/schemas/CommonEclDefinitions_Photo' Duration: type: object description: Product duration. properties: unit: type: string enum: - MINUTES - HOURS - DAYS description: Unit of time (i.e. minutes, hours, days). value: type: number minimum: 1 description: Value of time. ProductItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: photos: $ref: '#/components/schemas/Photos' cost: $ref: '#/components/schemas/ContentListCost' idcode: type: string description: Displayed item ID. url: type: string description: Product home page. video: type: string description: Youtube URL. duration: $ref: '#/components/schemas/Duration' ranking: type: number minimum: 0 description: Product ranking. ProductEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/ProductItem' Product: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: currency: type: string description: The three-letter ISO 4217 currency code. Defaults to USD. sections: type: array description: A list of sections. items: $ref: '#/components/schemas/ProductEcl_Section' EventItem: allOf: - $ref: '#/components/schemas/BaseEclItem' - type: object properties: type: type: string description: User-provided event type. starts: type: string format: date description: Start time in ISO 8601 format (yyyy-mm-ddThh:mm) (e.g., 2012-01-09T04:00). ends: type: string format: date description: End time in ISO 8601 format (yyyy-mm-ddThh:mm) (e.g., 2012-01-09T05:00). photos: $ref: '#/components/schemas/Photos' url: type: string description: Item URL. video: type: string description: Youtube URL. EventEcl_Section: allOf: - $ref: '#/components/schemas/BaseEclSection' - type: object properties: items: type: array description: Section Items. items: $ref: '#/components/schemas/EventItem' Event: allOf: - $ref: '#/components/schemas/BaseEcl' - type: object properties: sections: type: array description: A list of sections. However, Calendars cannot have more than one section. items: $ref: '#/components/schemas/EventEcl_Section' 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`. 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. 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' 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' Translation: type: object properties: languageCode: type: string description: Language code of the translation. value: type: string description: Localized value of the string. 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' EntityTypes: type: string enum: - location - event - healthcareProfessional - healthcareFacility - atm - restaurant 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. FieldUpdate: type: object required: - name properties: name: type: object description: | The Custom Field's name (including default value and translations). After March 19th 2020, if users **Update** Custom Field's name using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. **Example:** "name": { "value": "The promotions", "translations": [ { "languageCode": "fr", "value": "Les promotions" } ] } 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`. List of options (key, value, and translations) for the Custom Field. **Example:** { { "key": "TEMPORARILY_CLOSED", "value": "Temporarily Closed" }, { "key": "COMING_SOON", "value": "Coming Soon" }, { "key": "CLOSED", "value": "Closed" "translations": [ { "languageCode": "fr", "value": "Fermé" } ] }, { "key": "OPEN", "value": "Open" } } The behavior of the options' keys depends on which Custom Fields endpoint you are using: * Get and List: The options' keys will be included in the response. * Create: Do not specify option keys. They will be automatically assigned when the field is created. * 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. * **NOTE:** If you do not include an existing option in your Update request, it will be deleted. 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. After March 19th 2020, if users **Update** Custom Field's description using older versions of the API without explicitly specifiying translations, any existing translations will be cleared. **Example:** "description": { "value": "This is the list of promotions", "translations": [ { "languageCode": "fr", "value": "Ceci est la liste des promotions" } ] } 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' 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 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. PublisherDisruption: type: object properties: externalId: type: string description: External ID of the disruption. title: type: string description: Title of the disruption. severity: type: string description: Severity of the disruption. enum: - SEVERITY_UNSPECIFIED - CRITICAL - HIGH - MEDIUM - MINOR status: type: string description: Current status of the disruption. enum: - STATUS_UNSPECIFIED - INVESTIGATING - IDENTIFIED - MONITORING - ON_PUBLISHER - RESOLVED affectedProducts: type: array description: Products affected by the disruption. items: type: string enum: - AFFECTED_PRODUCT_UNSPECIFIED - LISTINGS - REVIEWS - SOCIAL - ANALYTICS lastEventTimestamp: type: string format: date-time description: Timestamp of the most recent event for the disruption. PublisherDisruptionStatusUpdate: type: object properties: externalId: type: string description: External ID of the status update. status: type: string description: Status represented by the update. enum: - STATUS_UNSPECIFIED - INVESTIGATING - IDENTIFIED - MONITORING - ON_PUBLISHER - RESOLVED messageHtml: type: string description: HTML message for the status update. eventTimestamp: type: string format: date-time description: Timestamp of the status update. EntityType: type: string enum: - LOCATION - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - EVENT - RESTAURANT - ATM - HOTEL Publisher: type: object properties: id: type: string description: Publisher ID name: type: string description: Publisher name url: type: string description: Publisher home page. Will link to Apple App Store for mobile-only apps alternateBrands: type: array description: List of Publisher's alternate brands where listings are syndicated items: type: object properties: name: type: string description: Alternate brand name url: type: string description: Alternate brand's home page supportedCountries: type: array description: List of countries where this Publisher publishes listings. Countries are denoted by ISO 3166 2-letter country codes items: type: string supportedLocationTypes: type: array description: | List of Location types that are supported by this Publisher Only present if the **`v`** parameter is before `20190111` items: $ref: '#/components/schemas/LocationType' supportedEntityTypes: type: array description: | List of Entity types that are supported by this Publisher Only present if the **`v`** parameter is `20190111` or later items: $ref: '#/components/schemas/EntityType' features: type: array description: List of features supported by this Publisher items: type: string enum: - DUAL_SYNC - SUBMISSION - SUPPRESSION - SUPPRESSION_BY_URL - REVIEW_MONITORING - PUBLISHER_SUGGESTIONS - ANALYTICS - SOCIAL - MENU_SYNC typicalUpdateSpeed: type: string description: Typical speed for updates to go live, in seconds ListingAccuracyField: type: object properties: fieldName: type: string description: Name of the compared field. fieldType: type: string description: Type of the compared field. entityData: type: string description: Entity value used by Verifier in the completed comparison. publisherData: type: string description: Publisher listing data used in the comparison. status: type: string description: Listing accuracy status for this field. enum: - LISTING_ACCURACY_STATUS_UNSPECIFIED - MATCH - MISMATCH - NOT_SYNCED - UNSUPPORTED ListingAccuracy: type: object properties: entityId: type: string description: ID of the entity associated with this listing accuracy result. publisherId: type: string description: ID of the publisher associated with this listing accuracy result. verificationTimestamp: type: string format: date-time description: Time when the listing accuracy comparison was completed. fields: type: array description: Field-level listing accuracy comparison results. items: $ref: '#/components/schemas/ListingAccuracyField' ListingStatusDetail: type: object properties: code: type: string description: Unique code for the warning/unavailable reason type: type: string enum: - UNAVAILABLE_REASON - WARNING message: type: string description: Explanation of the warning, or why the listing is unavailable actionable: type: boolean description: Indicates whether the customer can take action to resolve the issue unavailableReasonType: type: string description: The type of unavailable reason Listing: type: object properties: id: type: string description: ID of this listing locationId: type: string description: ID of the location associated with this listing accountId: type: string description: ID of the account associated with this listing publisherId: type: string description: | ID of publisher associated with this listing status: type: string enum: - WAITING_ON_YEXT - WAITING_ON_CUSTOMER - WAITING_ON_PUBLISHER - LIVE - UNAVAILABLE - OPTED_OUT additionalStatus: type: string enum: - CONNECTED - NOT_CONNECTED listingUrl: type: string description: Listing URL loginUrl: type: string description: URL where the user can log in to the publisher to manage this listing at that publisher (only returned for Google Business Profile) screenshotUrl: type: string description: URL of a screenshot of the profile page that includes the Featured Message statusDetails: type: array description: List of warnings, or reasons why the listing is unavailable items: $ref: '#/components/schemas/ListingStatusDetail' alternateBrands: type: array description: | *(only present if the **v** parameter is `20170420` or later)* List of Publisher's alternate brands where the listing is syndicated items: type: object properties: brandName: type: string description: Alternate brand name listingUrl: type: string description: The listing's URL on the alternate brand's site PublisherSuggestion: type: object properties: id: type: string description: ID of this Publisher Suggestion publisherId: type: string description: ID of the publisher who submitted the suggestion locationId: type: string description: ID of the location the suggestion is for dateCreated: type: string format: date description: The date Yext received the suggestion dateResolved: type: string format: date description: The date the suggestion expired or was accepted or rejected fieldName: type: string description: The location field the suggestion is for status: type: string description: The status of the suggestion enum: - WAITING_ON_CUSTOMER - ACCEPTED - REJECTED - EXPIRED resolvedBy: type: string description: Resolver of the Publisher Suggestion originalContent: type: string description: | The content that the publisher suggested to change suggestedContent: type: string description: | The content suggested as a replacement of the `originalContent` DuplicateUnavailableReason: type: object properties: code: type: string description: Unique code for the unavailable reason reason: type: string description: Explanation for why the listing is unavailable Duplicate: type: object properties: id: type: string description: ID of this duplicate listing publisherId: type: string description: ID of the publisher site where the duplicate listing appears locationId: type: string description: ID of the location the duplicate listing is for url: type: string description: URL of the duplicate listing name: type: string description: The business name that appears on the duplicate listing address: type: string description: The address that appears on the duplicate listing phone: type: string description: The phone number that appears on the duplicate listing latitude: type: string description: The latitude of the location, as shown on the duplicate listing (e.g., in a map view) longitude: type: string description: The longitude of the location, as shown on the duplicate listing (e.g., in a map view) status: type: string description: 'The status of the duplicate. Note: the `DELETED` status is only available in webhook responses.' enum: - POSSIBLE_DUPLICATE - SUPPRESSION_REQUESTED - SUPPRESSED - UNAVAILABLE - DELETED suppressionType: type: string description: The publisher's suppression type enum: - REDIRECT - ERROR - MERGE - REMOVE_FROM_SEARCH - MOBILE - SEARCH_PAGE unavailableReasons: type: array description: List of reasons why suppression is unavailable for this duplicate listing (will be empty unless **`status`** is `UNAVAILABLE`) items: $ref: '#/components/schemas/DuplicateUnavailableReason' VerificationMethod: type: object properties: entityId: type: string description: ID of the entity being verified. publisherId: type: string description: ID of the publisher for which the verification is happening. addressData: type: array items: type: object properties: businessName: type: string description: The business name that appears on the requested postcard that contains the verification code. address: type: string description: The address where the postcard containing the verification code will be sent. phoneData: type: array items: type: object properties: number: type: string description: The phone number that will receive the call or text message containing the verification code. emailData: type: array items: type: object properties: domainName: type: string description: | The domain name of the email address where the verification code will be sent. Ex: “@yext.com” in “test@yext.com” userName: type: string description: | The username portion of the email address where the verification code will be sent. Ex: “test” in “test@yext.com” userNameEditable: type: boolean description: If true, a verification may be initiated using a different username on the same email domain. VerificationStatus: type: object properties: entityId: type: string description: ID of the entity being verified. state: type: string enum: - VERIFICATION_STATE_UNSPECIFIED - PENDING - COMPLETED - FAILED createTime: type: string description: The time that the verification was created. VerificationInitiation: type: object properties: entityId: type: string description: ID of the entity being verified. method: type: string enum: - POSTCARD - EMAIL - PHONE - SMS alternateEmail: type: string description: | Provides a user-specified email address that the verification code should be sent to when **`userNameEditable`** is `true` in the VerificationMethod response. recipientName: type: string description: | Contact name the mail should be addressed to. Only applies if the verification **`method`** is `POSTCARD`. VerificationCompletion: type: object properties: entityId: type: string description: ID of the entity being verified. verificationCode: type: string description: The verification code received from the publisher. Admin: type: object properties: entityId: type: string description: ID of the entity that the admin belongs to. publisherId: type: string description: ID of the publisher for which the verification is happening. adminName: type: string description: | If the invitation to this admin is still pending, the email of the admin. If the admin has accepted the invitation and been successfully added, the name of the admin. role: type: string enum: - ADMIN_ROLE_UNSPECIFIED - OWNER - CO_OWNER - MANAGER - COMMUNITY_MANAGER - PRIMARY_OWNER pendingInvitation: type: boolean description: Indicates whether there is a pending invitation for this admin. AdminInvite: type: object properties: entityId: type: string description: ID of the entity that the admin will be associated with. adminEmail: type: string description: Email of the admin to be invited. EntityListing: type: object properties: id: type: string description: ID of this listing entityId: type: string description: ID of the entity associated with this listing accountId: type: string description: ID of the account associated with this listing publisherId: type: string description: ID of publisher associated with this listing status: type: string enum: - NOT_SYNCED - SYNC_IN_PROGRESS - LIVE - UPDATE_IN_PROGRESS - CANCELING_SYNC - NOT_APPLICABLE - DELETE_PENDING - DELETE_FAILED - DELETED - SYNC_STOPPED description: The status of this listing listingUrl: type: string description: The URL of this listing statusDetails: type: array description: List of warning messages or reasons why the listing is unavailable. Only included if the listing has a warning message or is unavailable. items: $ref: '#/components/schemas/ListingStatusDetail' Answer: type: object properties: id: type: integer description: ID of this answer. authorName: type: string description: The name of the person that created this answer. authorPhotoUrl: type: string description: The photo URL of the person that created this answer. authorType: type: string enum: - REGULAR_USER - LOCAL_GUIDE - MERCHANT - AUTHOR_TYPE_UNSPECIFIED upvoteCount: type: integer description: Number of upvotes the answer has. content: type: string description: The answer text. createTime: type: integer description: Timestamp the answer was created on the publisher. updateTime: type: integer description: Timestamp the answer was last updated on the publisher. Question: type: object properties: id: type: string description: ID of this question. entityIds: type: array description: IDs of the entities associated to this question. items: type: string accountId: type: string description: ID of the account associated with this question. publisherId: type: string description: | ID of the publisher associated with this question. For first-party Q&A, this will be FIRSTPARTY. authorName: type: string description: The name of the person that asked the question. authorEmail: type: string description: | The email of the person that asked the question. Only supported for FIRSTPARTY Q&A. authorPhotoUrl: type: string description: The photo URL of the person that asked the question. authorType: type: string enum: - REGULAR_USER - LOCAL_GUIDE - MERCHANT - AUTHOR_TYPE_UNSPECIFIED language: type: string description: The language of the question. Only supported for FIRSTPARTY Q&A. upvoteCount: type: integer description: Number of upvotes the question has. content: type: string description: The question text. description: type: string description: Additional description text. Only supported for FIRSTPARTY Q&A. createTime: type: integer description: Timestamp the question was created on the publisher. updateTime: type: integer description: Timestamp the question was last updated on the publisher. answerCount: type: integer description: Number of answers the question has. answers: type: array items: $ref: '#/components/schemas/Answer' Metric: type: object properties: id: type: string description: The ID of an Analytics metric for which reporting data can be retrieved. completedDate: format: date type: string description: The date until which complete data for the metric is available, in `YYYY-MM-DD` format. AnalyticsFilter: type: object properties: ANSWERS_BACKEND: type: array description: Backend(s) used to return results. items: type: string enum: - ALGOLIA - BING_CSE - CUSTOM_SEARCHER - GOOGLE_CSE - KNOWLEDGE_MANAGER - ZENDESK - UNKNOWN ANSWERS_BLANK_SEARCH_TERM: type: boolean description: Indicates whether no Search Term was entered for Search. ANSWERS_CLICK_LABEL: type: string description: Label assigned to CTA_CLICK types. ANSWERS_CLICK_TYPE: type: string description: Type of click performed by user. ANSWERS_CLICK_URL: type: string description: URL user was sent to on click, e.g. Google Maps on Driving Directions click. ANSWERS_CLUSTER: type: string description: Name of the Cluster a Search Term belongs to. Search Term Clusters are named by using the most popular Search Term (based on Sessions) within the Cluster. ANSWERS_CONFIGURATION_VERSION: type: array description: Version Number of Configuration Search was run on. items: type: string ANSWERS_CONFIGURATION_VERSION_LABEL: type: array description: Version Label of Configuration Search was run on. items: type: string ANSWERS_DIRECT_ANSWER_CLICK: type: boolean description: Indicates whether click was a from Direct Answer. ANSWERS_DIRECT_ANSWER_FIELD: type: string description: Field returned in Direct Answer. ANSWERS_DIRECT_ANSWER_FIELD_TYPE: type: array description: Type of Field used for Direct Answer returned for a Search. items: type: string ANSWERS_DIRECT_ANSWER_FIELD_VALUE: type: string description: Value returned in Direct Answer. ANSWERS_DIRECT_ANSWER_TYPE: type: array description: Type of Direct Answers returned for a Search. items: type: string ANSWERS_EXPERIENCE: type: array description: Name of Answers Experience. items: type: string ANSWERS_FILTER_KEY: type: array description: Field from the Knowledge Graph which Search filtered on. items: type: string ANSWERS_FILTER_OPERATOR: type: array description: Operator used for filter. items: type: string enum: - BETWEEN - EQUALS - EQUAL_TO - GREATER_THAN - GREATER_THAN_OR_EQUAL_TO - LESS_THAN - LESS_THAN_OR_EQUAL_TO - NEAR - OPEN_AT ANSWERS_FILTER_SOURCE: type: array description: Operator used for filter. items: type: string enum: - ALGO - QUERY_RULE - UI ANSWERS_FILTER_TYPE: type: array description: Type of filter applied. items: type: string enum: - FACET - NLP - STATIC ANSWERS_FILTER_VALUE: type: array description: Value used to filter Search. items: type: string ANSWERS_HAS_CASE_START: type: boolean description: Indicates the first search in the case creation process. ANSWERS_HAS_CASE_SUBMIT: type: boolean description: Indicates the last search in the case creation process. ANSWERS_HAS_KG_RESULTS: type: boolean description: Include only searches with results from the Knowledge Graph. ANSWERS_HAS_SEARCH_TERM_CLUSTER: type: boolean description: Indicates whether a Search Term belongs to a Search Term Cluster. Search Terms may not belong to a cluster if they do not pertain to any other terms searched on your experience or if it is a new term that has been searched for the first time since clustering was last run. ANSWERS_HAS_VOICE_SEARCH: type: boolean description: Includes only searches made using voice search. ANSWERS_QUERY_SOURCE: type: array description: 'The integration source from which this search originated. This includes the following options: STANDARD (standard search bar) and OVERLAY (within an search overlay).' items: type: string enum: - STANDARD - OVERLAY ANSWERS_RAW_SEARCH_TERM: type: string description: Raw Search Term entered by user for Search. ANSWERS_REFERRER_DOMAIN: type: string description: Domain of page where user was sent from, e.g. jobs.mysite.com. ANSWERS_REFERRER_PAGE_URL: type: string description: URL of page where user was sent from e.g. https://jobs.mysite.com/careers/open-positions/. ANSWERS_RESULT_ENTITY_POSITION: type: integer description: Position Entity was returned within Vertical. ANSWERS_RESULT_TITLE: type: string description: Title of Result from Third Party Backends. For results that come from Knowledge Graph backends this will be blank. ANSWERS_RESULT_VERTICAL_POSITION: type: integer description: Position of Verticals in Result. ANSWERS_SEARCH_ID: type: string description: ID of Search. ANSWERS_SEARCH_TERM: type: string description: 'Normalized Search Term of Search. Normalization removes: Capitalization, Punctuation, White Space.' ANSWERS_SEARCH_TERM_CLUSTER_PERFORMANCE: type: array description: | Identify how well a cluster is performing based on % of Total Searches and Click Through Rate. Cluster Performance breaks down into four groups with ids between 0-3. 0: Needs Attention - Large Cluster 1: Needs Attention - Small Cluster 2: Performing Well - Small Cluster 3: Performing Well - Large Cluster items: type: integer ANSWERS_SEARCH_TERM_INTENT: type: string description: Whether Search Term should be boosted or blacklisted based on your experience config. Options include BOOSTED and BLACKLISTED. ANSWERS_SEARCH_VERTICAL: type: array description: Vertical Search was ran on. items: type: string ANSWERS_SESSION_ID: type: string description: ID of Session Search was run in. ANSWERS_TRAFFIC_TYPE: type: array description: Type of Traffic. items: type: string enum: - EXTERNAL - INTERNAL ANSWERS_USER_BROWSER: type: array description: Browser of the user running the Search. items: type: string ANSWERS_USER_CITY: type: string description: City of user running Search. ANSWERS_USER_COUNTRY: type: string description: Country of user running Search. ANSWERS_USER_DEVICE_CLASS: type: string description: Device of user running Search. ANSWERS_USER_LAT_LONG: type: string description: Lat, Long of user running Search. ANSWERS_USER_LOCATION_ACCURACY: type: string description: Method for identifying user location. Options include Unknown, Device, and IP. ANSWERS_USER_POSTAL_CODE: type: array description: Postal code of the user running the Search. items: type: string ANSWERS_USER_REGION: type: array description: Region of the user running the Search. items: type: string ANSWERS_VERTICAL_RETURNED: type: array description: Vertical returned in results for a Search. items: type: string CLICK_TYPE: type: array description: Conversion Tracking click type. items: type: string enum: - ADD_TO_CART - APPLY_NOW - BOOK_APPOINTMENT - CALL - CALL_TO_ACTION - DETAIL - DRIVING_DIRECTIONS - EMAIL - FEATURED_MESSAGE - ORDER_NOW - ROW_EXPAND - RSVP - THUMBS_UP - TITLE - UBER_LINK - WEB - OTHER - UNKNOWN CONFIGURATION_VERSION_LABEL: type: array description: Configuration Version Label. items: type: string enum: - PRODUCTION - STAGING CONVERSION_TYPE: type: array description: Conversion Type. items: type: string enum: - COST_SAVING_CUSTOMER_SUPPORT - COST_SAVING_OTHER - LEAD - NO_TYPE - PAGE_VIEW - PURCHASE - SIGN_UP - OTHER_CONVERSION_TYPE - UNKNOWN_CONVERSION_TYPE MEDIUM: type: string description: Conversion tracking medium. PRODUCT: type: array description: Identify conversion analytics by the product in which they occurred. items: type: string enum: - ANSWERS - LISTINGS - PAGES - UNKNOWN TRAFFIC_SOURCE: type: array description: Identify conversion analytics by the source of the traffic. items: type: string enum: - EXTERNAL - INTERNAL - UNKNOWN_TRAFFIC_SOURCE VALUE_PROPOSITION: type: array description: Identify conversion analytics by their value proposition. items: type: string enum: - COST_SAVINGS - REVENUE_GENERATING VERTICAL_CONFIG_ID: type: string description: Vertical Config ID. age: type: array description: Array of age groups. Can only be used with Facebook metrics. items: type: string enum: - AGE13_17 - AGE18_24 - AGE25_34 - AGE35_44 - AGE45_54 - AGE55 - UNKNOWN VISITOR_EMAIL: type: array description: Email of Unique Visitor who triggered event. items: type: string VISITOR_ID: type: array description: ID of Unique Visitor who triggered event. items: type: string VISITOR_ID_METHOD: type: array description: Method used to identify Visitor. items: type: string VISITOR_NAME: type: array description: Name of Unique Visitor who triggered event. items: type: string competitor: type: array items: type: string description: Competitors monitored by the Intelligent Search Tracker. Can only be used with Intelligent Search Tracker metrics. countries: type: array items: type: string description: Array of 3166 Alpha-2 country codes. customerActionType: type: array description: | Specifies the type of customer actions to be included in the report. Can only be used with the `GOOGLE_CUSTOMER_ACTIONS` and `YELP_CUSTOMER_ACTIONS` metrics. items: type: string enum: - ACTION_DRIVING_DIRECTIONS - ACTION_PHONE - ACTION_WEBSITE endDate: type: string format: date description: | The exclusive end date for the report data. Defaults to the earliest of the relevant maximum reporting dates. Must be after the date given in **`startDate`**. NOTES: - If **`dimensions`** contains `WEEKS`, or `MONTHS`, the end date must coincide with the end of a week or month, depending on the dimension chosen. - If the **`v`** parameter is before `20180314`, the end date is inclusive, and the end date must be on or after the date given in **`startDate`**. example: '2017-01-31' entityGroup: type: array description: Array of entity groups. items: type: string enum: - CATEGORIES - EVENTS - LOCATIONS - ORGANIZATIONS - PEOPLE - UNKNOWN entityIds: type: array items: type: string description: Array of entity IDs. entityType: type: array description: Array of entity types. items: type: string enum: - ATM - CATEGORY_PAGE - EVENT - HEALTHCARE_PROFESSIONAL - HEALTHCARE_FACILITY - LOCATION - ORGANIZATION - RESTAURANT eventSearchCondition: type: array description: Array of event search conditions. items: type: string enum: - INITIAL_SCAN - DAYS28_PRIOR - DAYS7_PRIOR - DAY_OF - DAYS7_AFTER facebookImpressionType: type: array description: Array of Facebook impression types. items: type: string enum: - ORGANIC - PAID - VIRAL facebookRsvpType: type: array description: Array of Facebook RSVP types. items: type: string enum: - ATTENDING - DECLINED - INTERESTED - MAYBE facebookStoryType: type: array description: Array of Facebook RSVP types. items: type: string enum: - CHECKIN - COUPON - EVENT - FAN - MENTION - OTHER - PAGE_POST - QUESTION - USER_POST folderIds: type: array items: type: integer description: | Specifies a list of folders whose locations and subfolders should be included in the results. Defaults to all folders. Cannot be used when `ACCOUNT_ID` is in **`dimensions`**. foursquareCheckinAge: type: array description: Array of Foursquare check-in age groups. items: type: string enum: - AGE13_17 - AGE18_24 - AGE25_34 - AGE35_44 - AGE45_54 foursquareCheckinGender: type: string description: Foursquare check-in gender. enum: - FEMALE - MALE foursquareCheckinTimeOfDay: type: array description: Array of Foursquare check-in times. items: type: string enum: - MORNING - NOON - AFTERNOON - EVENING - NIGHT foursquareCheckinType: type: string description: Foursquare check-in type. enum: - NEW - REPEAT frequentWords: type: array description: Specifies the words that should be included in the report. Can only be used with Reviews metrics. items: type: string gender: type: string enum: - FEMALE - MALE - UNIDENTIFIED googleActionType: type: array description: | Specifies the type of customer actions to be included in the report. Can only be used with the `GOOGLE_CUSTOMER_ACTIONS` metric. items: type: string enum: - ACTION_DRIVING_DIRECTIONS - ACTION_PHONE - ACTION_WEBSITE googleQueryType: type: array description: Specifies the type of queries to be included in the report. Can only be used with the `GOOGLE_SEARCH_QUERIES` metric. items: type: string enum: - QUERIES_CHAIN - QUERIES_DIRECT - QUERIES_INDIRECT hours: type: array description: Specifies the hour(s) of day that should be included in the report. Can only, and must be used with the `GOOGLE_PHONE_CALLS` metric. items: type: number format: integer minimum: 0 maximum: 23 instagramContentType: type: string description: Instagram content type. enum: - PHOTO - VIDEO keyword: type: array items: type: string description: The keyword used to create search requests. Can only be used with Intelligent Search Tracker metrics. listingsLiveType: type: string description: Specifies the type of listings live that should be included in the report. Can only be used with `LISTINGS_LIVE` metric. enum: - CLAIMED - CREATED locationIds: type: array items: type: string description: Array of location IDs locationLabels: type: array items: type: string description: Array of location labels. Cannot be used with `NEW_REVIEWS` or `AVERAGE_RATING` metrics. matchPosition: type: array description: The local pack or organic position of the search result. Can only be used with Intelligent Search Tracker metrics. items: type: string enum: - ONE - TWO - THREE - FOUR - FIVE - SIX_TO_TEN matchType: type: array description: One of Local Map Pack, Listings, Pages and Corporate Website. Can only be used with Intelligent Search Tracker metrics. items: type: string enum: - COMPETITOR - COMPETITOR_PAID_AD - CORPORATE_WEBSITE - LISTINGS - LOCAL_PACK - LOCATION_PAGES - NO_MATCH - PAID_AD maxSearchFrequency: type: number format: double description: Maximum number of times a search term may have been used. minSearchFrequency: type: number format: double description: Minimum number of times a search term may have been used. pageTypes: type: array description: Specifies the Pages page types that should be included in the report. Can only be used with Store Pages metrics items: type: string enum: - DIRECTORY - SEARCH - STORE partners: type: array description: Specifies the partners that should be included in the report. Can only be used with Reviews metrics. items: type: number format: long platformType: type: array items: type: string enum: - BOT - DESKTOP - MOBILE - TABLET - UNKNOWN description: Array of platform types. publisherSuggestionType: type: array description: Specifies the types of publisher suggestions that should be included in the report. Can only be used with `PUBLISHER_SUGGESTIONS` metric. items: type: string enum: - ACCEPTED - CANCELED - NEW - REJECTED queryTemplate: type: array description: The query template used to create search requests. Can only be used with Intelligent Search Tracker metrics. items: type: string enum: - KEYWORD - KEYWORD_CITY - KEYWORD_CITY_STATE - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_ZIP ratings: type: array description: Specifies the ratings to be included in the report. Can only be used with Reviews metrics. items: type: integer minimum: 1 maximum: 5 reviewLabels: type: array description: Specifies the review labels that should be included in the report. Can only be used with Reviews metrics. items: type: number format: long searchEngine: type: array description: The search engine used for the Intelligent Search Tracker. Can only be used with Intelligent Search Tracker metrics. items: type: string enum: - BING_DESKTOP - GOOGLE_DESKTOP - GOOGLE_MOBILE - YAHOO_DESKTOP searchResultType: type: array description: One of Organic, Local Pack or Knowledge Card. Can only be used with Intelligent Search Tracker metrics. items: type: string enum: - KNOWLEDGE_CARD_RESULT - LOCAL_PACK_RESULT - ORGANIC_RESULT searchTerms: type: string sentimentCollection: type: array description: Specifies the sentiment collection that should be included in the report. Can only be used with Reviews metrics. items: type: number format: integer startDate: type: string format: date description: | The inclusive start date for the report data. Defaults to 90 days before the end date. Must be before the date given in **`endDate`**. E.g. ‘2016-08-22’ NOTE: If `WEEKS`, or `MONTHS` is in **`dimensions`**, **`startDate`** must coincide with the beginning and end of a week or month, depending on the dimension chosen. example: '2017-01-01' CreateReportRequestBody: type: object required: - metrics - dimensions properties: metrics: type: array items: type: string description: | The kinds of data the report should include. Specify up to 10 values. dimensions: type: array items: type: string description: | Determines how the data will be grouped. Specify up to 10 values.

**NOTES:**
You can only use one time-based dimension (e.g., `DAYS`, `WEEKS`) per report.
You can only use one location-based dimension (e.g., `FOLDER_IDS`, `LOCATION_NAMES`) per report.

filters: $ref: '#/components/schemas/AnalyticsFilter' CreateQueryRequestBody: type: object required: [] properties: fields: type: array description: 'Fields to return in request e.g. `"fields":["eventTimestamp","accountId"]`.

This field is optional and will return all fields if no fields are specified. All fields can also be explicitly specified as follows: `"fields" : ["*"]`' items: type: string pageSize: type: number description: Maximum number of records to return in request e.g. `"pageSize":100`.

This field is optional and will be set to 50 records if no pageSize is specified. pageSize supports a max 1,000 records. If query returns greater than pageSize specified, additional records require pagination. descending: type: boolean description: 'Order of records are returned based on timestamp e.g. `"descending": true`.

This field is optional and will return records in ascending order if not specified.' filter: type: string description: | Filter to apply to request e.g. `"filter": "eventTimestamp < '2022-03-10T12:23:23.800Z'"`

Filter Operators supported by Logs API: * **`&&`**: Combines multiple filter operators together. Records returned must satisfy both filters. * **`||`**: Combines multiple filter operators together. Records returned must satisfy either filter. * **`==`**: Returns records where field equals value. * **`!=`**: Returns records where field does not equal value. * **`<`**: Returns records where field is less than value. * **`>`**: Returns records where field is greater than value. * **`<=`**: Returns records where field is less than or equal value. * **`>=`**: Returns records where field is greater than or equal value. * **`has`**: Returns records where field is not null. * **`!has`**: Returns records where field is null. * **`in`**: Returns records where field equals value(s) in array. * **`!in`**: Returns records where field does not equal value(s) in array. * **`{FIELD}.containsAnyCase`**: Returns records where value exists in string field. * **`!{FIELD}.containsAnyCase`**: Returns records where value does not exist in string field.
This field is optional and will apply no filters if no filters are specified. pageToken: type: string description: 'Token for paginating queries which return more records than the pageSize specified e.g. `"pageToken": "BeYwVgOhe_fEz9VhfSES4GPDt6jElk7AHN6plsP_TLXk27rlG0YyYc78AOI_oyILcw"`.

This is optional and should only be used when your query returns more records than your pageSize (indicated by the nextPageToken being returned in your response body.)' Attestation: type: object description: | Attestation certifying SEC compliance requirements for review responses. This is only relevant when the Compliant Review Response setting is enabled for the account. required: - reviewerWasPaid - reviewerIsClient - isConflictOfInterest properties: reviewerWasPaid: type: boolean description: | Indicates whether the reviewer was paid or otherwise compensated for the review. reviewerIsClient: type: boolean description: | Indicates whether the reviewer is a client of the business. isConflictOfInterest: type: boolean description: | Indicates whether there is a conflict of interest between the reviewer and the business. conflictOfInterestDetails: type: string description: | Details about the conflict of interest. This field is required when `isConflictOfInterest` is `true`. ReviewComment: type: object properties: id: type: integer description: ID of this comment (assigned by Yext). readOnly: true parentId: type: integer description: If this comment is in response to another comment, this is the ID of the parent comment. publisherDate: type: integer format: int64 description: The timestamp of the comment as reported by the publisher. If edits impact the comment timestamp on the publisher, then this timestamp may change. This timestamp always comes from the publisher and we respect whatever they have. readOnly: true authorName: type: string description: The name of the person who wrote the comment (if we have it). readOnly: true authorEmail: type: string description: The email address of the person who wrote the comment (if we have it). readOnly: true authorRole: type: string enum: - BUSINESS_OWNER - CONSUMER readOnly: true content: type: string description: Content of the comment. visibility: type: string enum: - PUBLIC - PRIVATE description: Defaults to `PUBLIC` when creating a comment date: type: string format: date description: | If the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date the comment was posted. Date defaults to the date the comment was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date the comment was posted. Date defaults to the date the comment was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00 suppressReviewerContact: type: boolean description: | Indicates whether or not the reviewer receives an email notification when a comment is posted. Defaults to `false`. attestation: $ref: '#/components/schemas/Attestation' description: | SEC compliance attestation for the review response. This field is only relevant when the **Compliant Review Response** setting is enabled for the account. When the Compliant Review Response setting is enabled: * The `attestation` field is **required** * The `Yext-User-Id` header is **required** (must be the user ID of the person submitting the attestation) * The response code for successful requests is **202 Accepted** When the Compliant Review Response setting is disabled: * The `attestation` field is ignored ReviewLabel: type: object properties: id: type: integer description: The ID of this review label. readOnly: true name: type: string description: The name of this review label. readOnly: true Review: type: object properties: id: type: integer description: ID of this review readOnly: true locationId: type: string description: ID of the location associated with this review accountId: type: string description: ID of the account associated with this review publisherId: type: string description: | For third-party reviews, the ID of publisher associated with this listing. For first-party reviews, this will be FIRSTPARTY. readOnly: true rating: type: number format: double description: | Normalized rating out of 5. This value is omitted if the review does not include a rating. title: type: string description: | Title of the review. This value is omitted if reviews on the publisher's site do not have titles. readOnly: true content: type: string description: | Content of the review. authorName: type: string description: The name of the person who wrote the review (if we have it). authorEmail: type: string description: The email address of the person who wrote the review (if we have it). url: type: string description: The URL of the review, or the URL of the listing where the review can be found if there is no specific URL for the review. readOnly: true publisherDate: type: integer format: int64 description: The timestamp of the review as reported by the publisher. If edits impact the review date on the publisher, then this date may change. This date always comes from the publisher and we respect whatever they have. readOnly: true lastYextUpdateTime: type: integer format: int64 description: | If the **`v`** parameter is before `20170512`: the timestamp of the review (including listing updates). If the **`v`** parameter is `20170512` or later: the timestamp of the review (excluding listing updates), or the timestamp of the latest comment on the review. readOnly: true status: type: string enum: - LIVE - QUARANTINED - REMOVED description: The current status of the review; only returned for First Party and External First Party reviews. Defaults to `QUARANTINED` when creating. flagStatus: type: string enum: - FLAGGED - NOT_FLAGGED description: Indicates whether the review has been flagged for inappropriate or irrelevant content. Note that only First Party and External First Party reviews can be flagged. reviewLanguage: type: string description: The language of the review, if identified. comments: type: array description: | An ordered array of Comments on the review. **NOTE:** The order is a flattened tree with depth ties broken by publisher date. readOnly: true items: $ref: '#/components/schemas/ReviewComment' labelIds: type: array description: | If the **`v`** parameter is before `20180710`: The IDs of the review labels added to the review. If the **`v`** parameter is `20180710` or later: Not present. **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. readOnly: true items: type: integer format: int64 reviewLabels: type: array description: | If the **`v`** parameter is before `20180710`: Not present. If the **`v`** parameter is `20180710` or later: The names and IDs of the review labels added to the review. **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. readOnly: true items: $ref: '#/components/schemas/ReviewLabel' reviewType: type: string enum: - Rating - Recommendation description: | If the **`v`** parameter is before `20181002`: Not present. If the **`v`** parameter is `20181002` or later: Indicates whether the review is a rating or a recommendation. **NOTE:** Only applicable to Facebook reviews. readOnly: true recommendation: type: string enum: - Recommended - Not Recommended description: | If the **`v`** parameter is before `20181002`: Not present. If the **`v`** parameter is `20181002` or later: Indicates whether the consumer recommends the entity being reviewed. **NOTE:** Only applicable to Facebook reviews. readOnly: true transactionId: type: string description: | If present, the transaction ID associated with the invitation that resulted in this review. invitationId: type: string description: | If present, the ID associated with the invitation that resulted in this review. apiIdentifier: type: string description: | The unique identifier which will need to be included in any further requests to update or delete this review via the Review Submission API. Only supported for reviews created via Yext invitations or the Review Submission API. One of: * A UUID generated at the time the Review Creation request is accepted. * The invitationUid, if the review is associated with an invitation. CreateReview: type: object required: - entityId - authorName - rating properties: entityId: type: string description: ID of the entity associated with this review. authorName: type: string description: The name of the person who wrote the review. rating: type: number format: double description: | Normalized rating out of 5. content: type: string description: | Content of the review. authorEmail: type: string description: The email address of the person who wrote the review. status: type: string enum: - LIVE - QUARANTINED - REMOVED description: | The current status of the review; only returned for First Party and External First Party reviews. Defaults to `QUARANTINED` when creating. date: type: string format: date description: | If the v parameter is before 20240515: (YYYY-MM-DD format) If provided, the date you received the review from the customer. Defaults to the date the review was uploaded to Yext. Time defaults to midnight ET. If the v parameter is 20240515 or later: ISO-8601 format (YYYY-MM-DDThh:mm:ssTZD) if provided, the date you received the review from the customer. Date defaults to the date the review was uploaded to Yext. Time defaults to midnight and timezone defaults to UTC. Examples: 2024-05-15, 2024-05-15T04:44:50, 2024-05-15T04:44:50-05:00 publisherId: type: string description: | The ID of the publisher associated with the review. If v parameter is after 20240515, defaults to `FIRSTPARTY`. If v parameter is before 20240515, defaults to `EXTERNALFIRSTPARTY`. externalId: type: string description: | The External ID of the review, typically assigned by the Publisher. Created External IDs must be unique per entity and publisher pair. invitationUid: type: string description: | The ID of the invitation which should be associated with this review. UpdateReview: type: object properties: locationId: type: string description: ID of the location associated with this review rating: type: number format: double description: | Normalized rating out of 5. Can only be specified for External First Party Reviews. content: type: string description: | Content of the review. Can only be specified for External First Party Reviews. authorName: type: string description: | The name of the person who wrote the review. Can only be specified for External First Party Reviews. authorEmail: type: string description: | The email address of the person who wrote the review. Can only be specified for External First Party Reviews. status: type: string enum: - LIVE - QUARANTINED - REMOVED description: | The current status of the review. ReviewCommentUpdate: type: object properties: content: type: string description: Content of the comment. visibility: type: string enum: - PUBLIC - PRIVATE ReviewInvitationOptional: type: object properties: invitationUid: type: string readOnly: true description: | The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution. If the **`v`** parameter is before `20210728`, please refer to **`id`** as the parameter name instead of **`invitationUid`**. entity: type: object properties: id: type: string description: | ID of the entity associated with this review. If the **`v`** parameter is before `20210728`, please refer to **`locationId`** as the parameter name instead of **`entity`**. firstName: type: string description: The first name of the person from whom a review is being requested. lastName: type: string description: The last name of the person from whom a review is being requested. title: type: string description: | The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.). contact: type: string description: | The email address or phone number of the person from whom a review is being requested. Phone numbers should be formatted in one of the following ways: * E.164 standard international format, with a leading "+" * National format, according to the country of the corresponding location includeImage: type: boolean description: | Only valid for SMS invitations. If set to true, include the image provided in the relevant template in the SMS invitation. Please note that an image counts as an SMS message towards your SMS capacity. Otherwise, the SMS message will not include an image. If the **`v`** parameter is before `20210728`, please refer to **`image`** as the parameter name instead of **`includeImage`**. templateId: type: string description: | If specified, the ID of the template used to format the email. If not specified, the entity’s default email template is used. If the entity has no default template, the account’s default template is used. transactionId: type: string description: | The ID of the transaction being reviewed in response to this invitation. status: type: string enum: - ACCEPTED - REJECTED - PENDING readOnly: true details: type: string description: If status is REJECTED, describes why the invitation could not be processed. readOnly: true language: type: string description: | The ISO 639-1 code of the review invitation's language. Only valid for invitations created from built-in templates. Defaults to `en`. Supported languages: * `en` * `de` * `fr` * `es` * `it` * `nl` * `ja` additionalURLParameters: type: string description: | A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL. The **`additionalURLParameters`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. sendInvitationFromYext: type: boolean description: | Defaults to true. If set to false, Yext will not fulfill the invitation and will simply return the created invitation object. The **`sendInvitationFromYext`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. feedbackURL: type: string readOnly: true description: | The created Feedback URL unique to this invitation. The **`feedbackURL`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. reviewLabels: type: array readOnly: true items: type: object description: | Review Labels associated with the review. The **`reviewLabels`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. ReviewInvitationDates: type: object properties: sent: type: integer format: int64 description: | The timestamp the invitation was sent (seconds since epoch), if the invitation was sent. opened: type: integer format: int64 description: | The timestamp the invitation was opened (seconds since epoch), if the invitation was opened. This value will always be null for SMS type invitations. clicked: type: integer format: int64 description: The timestamp the invitation was clicked (seconds since epoch). reviewed: type: integer format: int64 description: | The timestamp the review was generated as a result of this invitation (seconds since epoch). If the **`v`** parameter is before `20210728`, please refer to **`responded`** as the parameter name instead of **`reviewed`**. GetReviewInvitation: allOf: - $ref: '#/components/schemas/ReviewInvitationOptional' - type: object properties: partnerId: type: string description: | The determined sender of the invitation. For invitations directed towards App Directory Partners, the ID of partner, otherwise this will be FIRSTPARTY. type: type: string enum: - EMAIL - SMS requested: type: integer format: int64 description: The timestamp the invitation was requested. - $ref: '#/components/schemas/ReviewInvitationDates' - type: object properties: reviewId: type: string description: ID of the review if this invitation resulted in a review ReviewInvitation: type: object required: - locationId - entity - firstName - lastName - contact properties: invitationUid: type: string readOnly: true description: | The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution. If the **`v`** parameter is before `20210728`, please refer to **`id`** as the parameter name instead of **`invitationUid`**. entity: type: object properties: id: type: string description: | ID of the entity associated with this review. If the **`v`** parameter is before `20210728`, please refer to **`locationId`** as the parameter name instead of **`entity`**. firstName: type: string description: The first name of the person from whom a review is being requested. lastName: type: string description: The last name of the person from whom a review is being requested. contact: type: string description: | The email address or phone number of the person from whom a review is being requested. Phone numbers should be formatted in one of the following ways: * E.164 standard international format, with a leading "+" * National format, according to the country of the corresponding location title: type: string description: | The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.). includeImage: type: boolean description: | Only valid for SMS invitations. If set to true, include the image provided in the relevant template in the SMS invitation. Please note that an image counts as an SMS message towards your SMS capacity. Otherwise, the SMS message will not include an image. If the **`v`** parameter is before `20210728`, please refer to **`image`** as the parameter name instead of **`includeImage`**. templateId: type: string description: | If specified, the ID of the template used to format the email. If not specified, the entity’s default email template is used. If the entity has no default template, the account’s default template is used. transactionId: type: string description: | The ID of the transaction being reviewed in response to this invitation. status: type: string enum: - ACCEPTED - REJECTED - PENDING readOnly: true details: type: string description: If status is REJECTED, describes why the invitation could not be processed. readOnly: true language: type: string description: | The ISO 639-1 code of the review invitation's language. Only valid for invitations created from built-in templates. Defaults to `en`. Supported languages: * `en` * `de` * `fr` * `es` * `it` * `nl` * `ja` additionalURLParameters: type: string description: | A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL. The **`additionalURLParameters`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. sendInvitationFromYext: type: boolean description: | Defaults to true. If set to false, Yext will not fulfill the invitation and will simply return the created invitation object. The **`sendInvitationFromYext`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. feedbackURL: type: string readOnly: true description: | The created Feedback URL unique to this invitation. The **`feedbackURL`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. reviewLabels: type: array readOnly: true items: type: object description: | Review Labels associated with the review. The **`reviewLabels`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. CreateReviewInvitationRequest: allOf: - $ref: '#/components/schemas/ReviewInvitation' - type: object properties: reviewLabelNames: type: array items: type: string description: | The names of the Review Labels which will be attached to the resulting review. This is an upsert operation, meaning the system will determine if a Review Label exists already in your account, and create and append a new label if not. The **`reviewLabelNames`** parameter will only be respected with the inclusion of a **`v`** parameter of `20210728` or later. delayTime: type: integer description: | The amount of time to wait before sending the invitation after creation. The **`delayTime`** parameter will only be respected with the inclusion of a **`v`** parameter of `20241211` or later. delayTimeUnit: type: string description: | If **`delayTime`** is set, specify the unit of time. Accepted values: `hours`, `days` The **`delayTimeUnit`** parameter will only be respected with the inclusion of a **`v`** parameter of `20241211` or later. sendTime: type: string description: | To send invites at a later time, provide an ISO formatted date/time value, e.g. `2024-09-04T12:00:00`. **`delayTime`** and **`sendTime`** cannot both be set on the same invite. The **`sendTime`** parameter will only be respected with the inclusion of a **`v`** parameter of `20241211` or later. UpdateReviewInvitationRequest: allOf: - $ref: '#/components/schemas/ReviewInvitationDates' - type: object properties: firstName: type: string description: | The first name of the person from whom a review is being requested. The **`firstName`** parameter will only be respected for **`v`** parameters of `20210728` or later. lastName: type: string description: | The last name of the person from whom a review is being requested The **`lastName`** parameter will only be respected for **`v`** parameters of `20210728` or later. title: type: string description: | The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.) The **`title`** parameter will only be respected for **`v`** parameters of `20210728` or later. contact: type: string description: | The email address or phone number of the person from whom a review is being requested. Phone numbers should be formatted in one of the following ways: * E.164 standard international format, with a leading "+" * National format, according to the country of the corresponding location The **`contact`** parameter will only be respected for **`v`** parameters of `20210728` or later. transactionId: type: string description: | The ID of the transaction being reviewed in response to this invitation. The **`transactionId`** parameter will only be respected for **`v`** parameters of `20210728` or later. additionalURLParameters: type: string description: | A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL. The **`additionalURLParameters`** parameter will only be respected for **`v`** parameters of `20210728` or later. status: type: string enum: - CANCELED description: | Cancel an existing review invitation with `PENDING` status by updating status to `CANCELED` Please note that if the invitation status is not `PENDING`, attempting to set the status to `CANCELED` will fail. errorCode: type: string description: | The error code of the invitation if applicable. Required if `errorReason` is specified. The **`errorCode`** parameter will only be respected for **`v`** parameters of `20210727` or earlier. errorReason: type: string description: | The error reason text of the invitation if applicable. Required if `errorCode` is specified. The **`errorReason`** parameter will only be respected for **`v`** parameters of `20210727` or earlier. UpdatedReviewInvitation: allOf: - type: object properties: invitationUid: type: string readOnly: true description: | The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution. If the **`v`** parameter is before `20210728`, please refer to **`id`** as the parameter name instead of **`invitationUid`**. entity: type: object properties: id: type: string description: | ID of the entity associated with this review. If the **`v`** parameter is before `20210728`, please refer to **`locationId`** as the parameter name instead of **`entity`**. firstName: type: string description: | The first name of the person from whom a review is being requested. The **`firstName`** parameter will only be respected for **`v`** parameters of `20210728` or later. lastName: type: string description: | The last name of the person from whom a review is being requested. The **`lastName`** parameter will only be respected for **`v`** parameters of `20210728` or later. title: type: string description: | The title of the person from whom a review is being requested (e.g., Mr., Mrs., Miss, etc.). The **`title`** parameter will only be respected for **`v`** parameters of `20210728` or later. contact: type: string description: | The email address or phone number of the person from whom a review is being requested. Phone numbers will be formatted in the E.164 standard international format, with a leading "+". The **`contact`** parameter will only be respected for **`v`** parameters of `20210728` or later. transactionId: type: string description: | The ID of the transaction being reviewed in response to this invitation. The **`transactionId`** parameter will only be respected for **`v`** parameters of `20210728` or later. additionalURLParameters: type: string description: | A JSON object containing the key, value pairs for any additional URL parameters. These URL parameters will be appended to the First-Party Review Collection URL. The **`additionalURLParameters`** parameter will only be respected for **`v`** parameters of `20210728` or later. status: type: string enum: - SENT - PENDING - CANCELED - ATTEMPTED - NOT_DELIVERED - FAILED - DISABLED errorCode: type: string description: | The error code of the invitation if applicable. The **`errorCode`** parameter will only be respected for **`v`** parameters of `20210727` or earlier. errorReason: type: string description: | The error reason text of the invitation if applicable. The **`errorReason`** parameter will only be respected for **`v`** parameters of `20210727` or earlier. - $ref: '#/components/schemas/ReviewInvitationDates' UpdateReviewLabelsRequest: type: object properties: labelIds: type: array items: type: integer description: The IDs of the review labels added to the review. ReviewGenerationSettings: type: object properties: maxEmailsPerDay: type: integer minimum: 0 maximum: 200 description: | Enables review invitations by email and indicates the maximum number of email invites our system will send on a per-location, per-day basis. Must contain an integer value between 0 and 200. If 0 or null, review invitations by email will be disabled. maxTextsPerMonth: type: integer minimum: 1 description: | Indicates the maximum number of text invites our system will send on a per-location, per-month basis. maxTextsPerDay: type: integer minimum: 1 maximum: 20 description: | Enables review invitations by text and indicates the maximum number of text invites our system will send on a per-location, per-day basis. We will send a maximum of 20 text invites per location per day. If null, review invitations by text will be disabled. maxContactsAllTime: type: integer enum: - 1 description: | When enabled, this setting will prevent you from contacting the same person more than once. This setting cannot be set when maxContactFrequency is enabled. If null, this setting will be disabled. maxContactFrequency: type: integer enum: - 7 - 30 - 60 - 90 description: | Indicates the minimum number of days that must pass before a given contact can be sent another review invitation. This setting will prevent you from contacting the same person repeatedly in a short time period. If null, no maximum contact frequency will be enforced. reviewQuarantineDays: type: integer minimum: 0 maximum: 7 description: | Prevents first-party reviews from immediately showing up on your website or wherever else you show your reviews. During this quarantine period, you may respond to reviews, increasing the likelihood that your customers will revise or remove their negative reviews. privacyPolicy: type: string description: | Review-collection pages contain a link to the Yext privacy policy by default. This field lets you replace that link with a link to your own privacy policy. Update request must contain a URL or null. If null, the Yext privacy policy link will be used. If the **`v`** parameter is before `20200910`, please refer to **`privacyPolicyOverride`** as the parameter name instead of **`privacyPolicy`**. balancingOptimization: type: string enum: - DISTRIBUTION - MORE_REVIEWS - MUST_BE_LOGGED_IN description: | Defaults to **`DISTRIBUTION`**. Optionally configure the algorithm to prioritize sites where you have fewer reviews to generate more reviews (**`MORE_REVIEWS`**), or prioritize sites where a user is already logged in on their device (**`MUST_BE_LOGGED_IN`**). algorithmConfiguration: type: array description: | Optionally prioritize the following issues to determine where to send review invites: **`WEBSITE`**: generate more first-party reviews if one of the last 5 reviews has 1 star, **`RATING`**: prioritize sites that have the lower rating, **`RECENCY`**: prioritize sites that haven’t received a review in the last month. items: type: string enum: - WEBSITE - RECENCY - RATING uniqueItems: true maxItems: 3 siteDistribution: type: object description: | Configure the target distribution of reviews for each site by specifying the ratio as an integer for each site to generate reviews for. E.g. **`GOOGLEMYBUSINESS: 1`** and **`FIRSTPARTY: 1`**, would send half of the review invites to Google and half to your First Party site. additionalProperties: type: integer minimum: 1 minProperties: 0 example: FACEBOOK: 3 GOOGLEMYBUSINESS: 5 FIRSTPARTY: 1 WorkflowRuleInput: type: object properties: assignee: type: string description: | Resource name or email address of the user assigned to tasks created by this workflow rule. Set only one of **`assignee`** or **`assigneeUserGroup`**. External email addresses that don't correspond to a user are only supported when **`ruleType`** is `GENERATIVE_REVIEW_RESPONSE` and **`autoPublishGenerativeResponse`** is false. Format: `accounts/{accountId}/users/{userId}` assigneeUserGroup: type: string description: | Resource name of the user group assigned to tasks created by this workflow rule. When this is set, tasks are assigned to the user in the group with the fewest open tasks. Set only one of **`assignee`** or **`assigneeUserGroup`**. Format: `accounts/{accountId}/userGroups/{userGroup}` displayName: type: string description: The name of the workflow rule. enabled: type: boolean description: Whether the workflow rule is enabled. domainConfiguration: type: object description: | Domain-specific configuration for the workflow rule. The supported keys depend on **`ruleType`**. Supported keys: - `filterCriteria` - `ruleApplication` - `automaticResponseAssetIds` - `autoPublishGenerativeResponse` properties: filterCriteria: type: string description: | CEL expression used to filter which reviews match the workflow rule. ruleApplication: type: string description: | Specifies when the workflow rule should be applied. enum: - NEW_REVIEWS - NEW_AND_UPDATED_REVIEWS - LABEL_APPLICATION automaticResponseAssetIds: type: array description: | IDs of response assets used when **`ruleType`** is `AUTOMATIC_REVIEW_RESPONSE`. items: type: integer autoPublishGenerativeResponse: type: boolean description: | Whether generative responses can be published without human approval. This is only used when **`ruleType`** is `GENERATIVE_REVIEW_RESPONSE`. ruleType: type: string description: The type of workflow rule. enum: - REVIEW_RESPONSE - AUTOMATIC_REVIEW_RESPONSE - GENERATIVE_REVIEW_RESPONSE dueDate: type: object description: | Relative due date applied to tasks created by the workflow rule. properties: value: type: integer description: Positive numeric value of the due date. unit: type: string description: Unit of time for the due date. enum: - HOUR - DAY - WEEK WorkflowRule: allOf: - $ref: '#/components/schemas/WorkflowRuleInput' - type: object properties: name: type: string description: | Resource name of the workflow rule. Format: `accounts/{accountId}/workflowRules/{workflowRuleId}` createTime: type: string description: Timestamp when the workflow rule was created. CreateWorkflowRule: allOf: - $ref: '#/components/schemas/WorkflowRuleInput' - type: object required: - displayName - domainConfiguration - ruleType UpdateWorkflowRule: allOf: - $ref: '#/components/schemas/WorkflowRuleInput' - type: object description: | Fields that may be supplied when updating a workflow rule. Updatable fields are `assignee`, `assigneeUserGroup`, `displayName`, `enabled`, `domainConfiguration`, `ruleType`, and `dueDate`. Output-only fields such as `createTime` are not part of this update schema. properties: name: type: string description: | Resource name of the workflow rule to update. Format: `accounts/{accountId}/workflowRules/{workflowRuleId}` Offer: type: object description: | Additional data for offer posts. Only supported on Google posts. properties: couponCode: type: string description: Offer code that is usable in store or online. Limit 58 characters. redeemOnlineUrl: type: string description: Online link to redeem offer. Must be a valid URL. termsConditions: type: string description: Offer terms and conditions. Limit 5000 characters. EventInfo: type: object required: - title - startTime - endTime description: | Event information. Required for topicType `EVENT` and `OFFER`. Only supported on Google posts. properties: title: type: string description: The title of the event. startTime: type: string description: | The start time of the event. Formatted as datetime in `YYYY-MM-DD HH:MM:SS` Ex: 2021-04-06 08:45:00. endTime: type: string description: | The end time of the event. Formatted as datetime in `YYYY-MM-DD HH:MM:SS`. Ex: 2021-04-06 08:45:00. Entity: type: object description: The entity which the post is for. properties: id: type: string description: The ID of the entity which the post is for. EntityPostStatus: type: object description: The status of the post. properties: status: type: string enum: - POST_SCHEDULED - POST_AWAITING_APPROVAL - POST_SUCCEEDED - POST_DELETED - POST_PROCESSING - POST_SAVING - DELETE_PROCESSING - POST_FAILED - DELETE_FAILED - REJECTED_BY_APPROVER description: Status of the entity post details: type: string description: Details about the status. Metrics: type: object description: The metrics for the entity post. properties: viewCount: type: number description: | The number of times post was viewed. uniqueViewCount: type: number description: | The number of times the post was viewed by a unique user. clickCount: type: number description: | The number of times the post was clicked. likeCount: type: number description: | The number of times the post was liked. loveCount: type: number description: Total "love" reactions of a post. Facebook only. Only present if the **`v`** parameter is on or after `20220728`. wowCount: type: number description: Total "wow" reactions of a post. Facebook only. Only present if the **`v`** parameter is on or after `20220728`. hahaCount: type: number description: Total "haha" reactions of a post. Facebook only. Only present if the **`v`** parameter is on or after `20220728`. sadCount: type: number description: Total "sad" reactions of a post. Facebook only. Only present if the **`v`** parameter is on or after `20220728`. angerCount: type: number description: Total "anger" reactions of a post. Facebook only. Only present if the **`v`** parameter is on or after `20220728`. Comment: type: object properties: commentId: type: string description: The ID of a specific comment. parentCommentId: type: string description: | The ID of the parent comment if this comment was created as a reply to another comment. **Instagram and Facebook only** authorName: type: string description: The author of the comment. text: type: string description: The text of the comment. hidden: type: boolean description: Indicates if the comment is hidden or not. **Instagram only** likes: type: integer description: Number of likes on the comment. **Instagram only** createdTimestamp: type: boolean description: The timestamp the comment was created. CommentWithReplies: allOf: - $ref: '#/components/schemas/Comment' - type: object properties: replies: type: array items: $ref: '#/components/schemas/Comment' description: Replies to the comment. Only one level of replies is supported. EntityPost: type: object properties: entityPostId: type: string description: The ID of the individual post for a given entity on a given publisher. entity: $ref: '#/components/schemas/Entity' publisher: type: string enum: - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS - LINKEDIN description: The publisher which the post was sent to. status: $ref: '#/components/schemas/EntityPostStatus' postUrl: type: string description: The URL where the post can be found metrics: $ref: '#/components/schemas/Metrics' comments: type: array items: $ref: '#/components/schemas/CommentWithReplies' description: Any comments on the post. Post: type: object properties: postId: type: string description: The ID of the post. entityId: type: array items: type: string description: The ID(s) of the entities which were included in the post. publishers: type: array items: type: string description: The publisher(s) the post was made on. postTitle: type: string description: The title of the post. This does not get sent out to the publisher network and is for internal use only. The title cannot exceed 250 characters. If a title is not provided, we will use the first 40 characters of the post text or if no text is provided then the title will be "Media Only Post". text: type: string description: The copy featured on the post. photoUrls: type: array items: type: string description: The list of URLs where the photos were retrieved from. videos: type: array description: Video to be posted to the publisher. Facebook and Instagram are supported and only one video can be uploaded per post. items: type: object required: - videoUrl - videoPostType properties: videoUrl: type: string description: A URL of a video to be posted to the publisher. The video must first be uploaded to Yext's CDN via the Upload Video endpoint. videoPostType: type: string description: The type of video post to be uploaded. Instagram only supports the `REEL` video post type. enum: - REEL - VIDEO coverImageUrl: type: string description: The cover image URL of the video. The first frame of the video will be used if a cover image is not provided. videoTitle: type: string description: The title of the video. Facebook only supports this for the `VIDEO` video post type. topicType: type: string description: The topicType of the post. Only supported on Google posts. Defaults to `STANDARD`. alertType: type: string description: The alertType of the post. offer: $ref: '#/components/schemas/Offer' clickthroughUrl: type: string description: The clickthroughUrl of the post. callToActionType: type: string description: | The callToActionType of the post. If the v parameter is >= 20221215, callToActionType 'SHOP' will be shown as 'BUY' eventInfo: $ref: '#/components/schemas/EventInfo' description: Event information for the post. createdDate: type: string description: The date the post was created. postDate: type: string description: The date posted or the scheduled date. postCreatedInYext: type: boolean description: | True if the post was originally created in Yext, otherwise False. entityPosts: type: array items: $ref: '#/components/schemas/EntityPost' description: The individual posts created for a given entity. CreatePost: type: object required: - entityIds - publisher properties: entityIds: type: array items: type: string description: ID(s) of the entities to post for publisher: type: string enum: - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS - LINKEDIN - TIKTOK description: | The publisher the post should be sent to. postTitle: type: string description: The title of the post. This does not get sent out to the publisher network and is for internal use only. The title cannot exceed 250 characters. If a title is not provided, we will use the first 40 characters of the post text or if no text is provided then the title will be "Media Only Post". text: type: string description: | The copy to be featured on the post. Please note that you should use double brackets for embedded fields if your **`v`** parameter is on or after `20250514`. If you are using the response from a Post: Generate Post Text call, then your **`v`** parameter must be on or after `20250514`, since responses from that call use double brackets for embedded fields. Character limits vary per publisher. Please refer to the following character limits: * Google Business Profile: 1500 * Facebook: 5000 * First Party: 5000 * LinkedIn: 3000 * TikTok: 2200 clickthroughUrl: type: string description: | Url included with the post. Required for Google posts that include a callToActionType except CALL photoUrls: type: array items: type: string description: | List of publicly accessible URLs where the photos can be retrieved from. **NOTE**: Currently supports up to 10 photo urls to create multi-image and carousel posts on Facebook and Instagram. TikTok also supports multi-photo posts via this field when used together with `tikTokPostFields.photoCoverIndex`. videos: type: array description: Video to be posted to the publisher. Facebook, Instagram, and TikTok are supported and only one video can be uploaded per post. items: type: object required: - videoUrl - videoPostType properties: videoUrl: type: string description: A URL of a video to be posted to the publisher. The video must first be uploaded to Yext's CDN via the Upload Video endpoint. videoPostType: type: string description: The type of video post to be uploaded. Instagram only supports the `REEL` video post type. TikTok only supports the `VIDEO` video post type. enum: - REEL - VIDEO coverImageUrl: type: string description: The cover image URL of the video. The first frame of the video will be used if a cover image is not provided. This field is not used for TikTok video posts. videoTitle: type: string description: The title of the video. Facebook only supports this for the `VIDEO` video post type. tikTokPostFields: type: object description: | TikTok-specific fields. This object is required when `publisher` is `TIKTOK`. For TikTok posts: * `privacyLevel` is required. * `complianceSetting` is required and must be `true`. * For multi-photo posts, `photoCoverIndex` is required and must reference one of the supplied `photoUrls`. * Private posts (`SELF_ONLY`) cannot enable comments, duet, or stitch, and cannot be branded content. * Multi-photo posts cannot enable duet or stitch. properties: privacyLevel: type: string description: The TikTok privacy level for the post. enum: - PUBLIC_TO_EVERYONE - MUTUAL_FOLLOW_FRIENDS - SELF_ONLY - FOLLOWER_OF_CREATOR enableComment: type: boolean description: Whether comments are enabled for the TikTok post. isBrandedContent: type: boolean description: Whether the TikTok post is branded content. isOrganicContent: type: boolean description: Whether the TikTok post is marked as organic branded content. enableDuet: type: boolean description: Whether duet is enabled for the TikTok post. This cannot be `true` for multi-photo posts. enableStitch: type: boolean description: Whether stitch is enabled for the TikTok post. This cannot be `true` for multi-photo posts. photoCoverIndex: type: integer description: The zero-based index of the cover image within `photoUrls` for a TikTok multi-photo post. multiPhotoTitle: type: string description: The title for a TikTok multi-photo post. Maximum length is 90 characters. complianceSetting: type: boolean description: TikTok content disclosure acknowledgment. This field is required for TikTok posts and must be `true`. postDate: type: string description: | If the post should be scheduled for some time in the future, specify a postDate in the future here. Formatted as datetime in `YYYY-MM-DD HH:MM:SS`. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. topicType: type: string enum: - ALERT - EVENT - OFFER - STANDARD description: The topicType of the post. Only supported on Google posts. Defaults to `STANDARD`. alertType: type: string enum: - ALERT_TYPE_UNSPECIFIED - COVID_19 description: | The type of alert the post is created for. **NOTE**: This field is only applicable for posts of topicType `ALERT`, and behaves as a sub-type of Alerts. Only supported on Google posts. offer: $ref: '#/components/schemas/Offer' callToActionType: type: string enum: - BOOK - CALL - LEARN_MORE - ORDER - SIGN_UP description: | The actionType of the post. Only supported on Google posts. eventInfo: $ref: '#/components/schemas/EventInfo' UpdatePost: type: object properties: text: type: string description: The copy to be featured on the post. photoUrls: type: array items: type: string description: | List of publicly accessible URLs where the photos can be retrieved from. **NOTE**: Currently only supports one photo. alertType: type: string enum: - ALERT_TYPE_UNSPECIFIED - COVID_19 description: | The type of alert the post is created for. This field is only applicable for posts of topicType `ALERT`, and behaves as a sub-type of Alerts. Defaults to `ALERT_TYPE_UNSPECIFIED`. offer: $ref: '#/components/schemas/Offer' callToActionType: type: string enum: - BOOK - CALL - LEARN_MORE - ORDER - SIGN_UP description: | The actionType of the post. Required for Google posts that include a clickthroughUrl. clickthroughUrl: type: string description: The clickthrough URL included with the post. eventInfo: $ref: '#/components/schemas/EventInfo' GeneratePostText: type: object oneOf: - title: textPrompt required: - entityIds - textPrompt properties: textPrompt: type: string description: | The text input to guide the post text generation. entityIds: type: array items: type: string description: ID(s) of the entities to generate post text for publishers: type: array items: enum: - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS - LINKEDIN - HEROLD description: | Publishers that the post text should generated for tone: type: string description: | Desired tone for the post text (eg. professional, friendly, humorous) postType: type: string description: | Type of post (eg. advertisement, educational, industry news) audience: type: string description: | Target audience description keywords: type: array items: type: string description: | List of keywords to include in the post text language: type: string description: | Desired language for the post text - title: imagePrompts required: - entityIds - imagePrompts properties: imagePrompts: type: array items: type: string description: | URL of the image(s) to guide the post text generation. entityIds: type: array items: type: string description: ID(s) of the entities to generate post text for publishers: type: array items: enum: - INSTAGRAM - FACEBOOK - FIRSTPARTY - GOOGLEMYBUSINESS - LINKEDIN - HEROLD description: | Publishers that the post text should generated for tone: type: string description: | Desired tone for the post text (eg. professional, friendly, humorous) postType: type: string description: | Type of post (eg. advertisement, educational, industry news) audience: type: string description: | Target audience description keywords: type: array items: type: string description: | List of keywords to include in the post text language: type: string description: | Desired language for the post text UploadVideo: type: object required: - publisher - videoUrl - videoPostType - uploadType properties: publisher: type: string enum: - INSTAGRAM - FACEBOOK description: | Upload a video to Yext's CDN to be used in a post. A video must be in Yext's CDN in order to be used in a Create Post request. videoUrl: type: string description: A non Yext-CDN URL of a video to be posted to the publisher. videoPostType: type: string description: The type of video post to be uploaded. Instagram only supports the `REEL` video post type. enum: - REEL - VIDEO uploadType: type: string description: The type of upload. Only `URL` is supported at this time. enum: - URL ConversationMessage: type: object properties: messageId: type: string description: ID of the message that was created messageText: type: string description: Text of the message. A message can either have messageText or atachments. attachments: type: array description: Attachments in the message. A message can either have messageText or atachments. items: properties: type: type: string description: Type of attachment url: type: string description: URL of the attachment outbound: type: boolean description: true if the message was sent from you type: type: string enum: - MESSAGE - EDITED_MESSAGE - UNSENT_MESSAGE - REPLY_MESSAGE - BUMP_MESSAGE - ATTACHMENT - REACTION - UNREACTION reactions: type: array items: properties: messageReaction: type: object properties: reaction: type: string description: The reaction sent in the message emoji: type: string description: The type of emoji sent in the message outbound: type: boolean description: true if the reaction was sent from you sentTimestamp: type: string format: date description: | The time the message was sent. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. editedTimestamp: type: string format: date description: | The time the message was edited. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. unsent: type: boolean description: true if the message was unsent ConversationMessageWithParent: type: object properties: messageId: type: string description: ID of the message that was created messageText: type: string description: Text of the message outbound: type: boolean description: true if the message was sent from you type: type: string enum: - MESSAGE - EDITED_MESSAGE - UNSENT_MESSAGE - REPLY_MESSAGE - BUMP_MESSAGE - ATTACHMENT - REACTION - UNREACTION reactions: type: array items: properties: messageReaction: type: object properties: reaction: type: string description: The reaction sent in the message emoji: type: string description: The type of emoji sent in the message outbound: type: boolean description: true if the reaction was sent from you sentTimestamp: type: string format: date description: | The time the message was sent. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. editedTimestamp: type: string format: date description: | The time the message was edited. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. unsent: type: boolean description: true if the message was unsent parent: $ref: '#/components/schemas/ConversationMessage' attachments: type: array items: properties: type: type: string description: Type of attachment url: type: string description: URL of the attachment Message: type: object properties: messageId: type: string description: ID of the message that was created publisher: type: string description: Publisher that the message was created on entityId: type: string description: ID of the entity that the message was created on type: type: string enum: - MESSAGE - EDITED_MESSAGE - UNSENT_MESSAGE - REPLY_MESSAGE - BUMP_MESSAGE - ATTACHMENT - REACTION - UNREACTION messageText: type: string description: Text of the message attachments: type: array items: properties: type: type: string description: Type of attachment url: type: string description: URL of the attachment reaction: type: object properties: reaction: type: string description: The reaction sent in the message emoji: type: string description: The type of emoji sent in the message outbound: type: boolean description: true if the reaction was sent from you readUnreadStatus: type: string description: The read status of the message enum: - READ - UNREAD outbound: type: boolean description: true if the message was sent from you user: type: object properties: id: type: string description: The user ID that the message was sent to name: type: string description: The name of the user (Facebook name or Instagram handle) avatarUrl: type: string description: The URL of the avatar of the user sentTimestamp: type: string format: date description: | The time the message was sent. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. editedTimestamp: type: string format: date description: | The time the message was edited. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. deadline: type: string format: date description: | The latest time to which you can send a message to the user. Formatted as datetime in YYYY-MM-DD HH:MM:SS. Ex: 2021-04-06 08:45:00. The timezone for the provided datetime will be UTC. Role: type: object properties: id: type: string description: The Yext Role ID name: type: string description: The Role's Name User: type: object properties: id: type: string description: ID of this User. firstName: type: string description: User's first name. lastName: type: string description: User's last name. username: type: string description: User's username. emailAddress: type: string description: User's email address. phoneNumber: type: string description: User's phone number. emailLanguagePreference: type: string description: Locale code of user's preferred email language. displayLanguagePreference: type: string description: Locale code of user's preferred display language in the Yext platform. lastLoginDate: type: string description: User's last login time in UNIX timestamp. createdDate: type: string description: Time of user creation in UNIX timestamp. sso: type: boolean description: Indicates whether SAML SSO has been enabled for this user. acl: type: array description: | Entries in the access-control list. If there are no entries, this field will be returned as empty. If the **`v`** parameter is before `20211115` acl entries are not returned for non-location entities. items: type: object properties: roleId: type: string description: The Yext Role ID. roleName: type: string description: The Role's Name. 'on': type: string description: The ID of the account, folder, or entity that this role gives the user access to. accountId: type: string description: The ID of the account that contains the folder or entity that this role applies to. onType: type: string description: The type of object that this role gives the user access to. enum: - ACCOUNT - FOLDER - ENTITY externalIdentities: type: array description: | An array of objects that have a source and an identities field. If there are no externalIdentities, this field will be returned as empty. If the **`v`** parameter is before `20211115` external identities will not be included. items: type: object properties: source: type: string description: A unique string, no two source/identities field pairs for a single user can have the same source value. identities: type: array description: An array of strings. Multiple users can have the same (source, identity) pair(s). items: type: string CreateUser: type: object properties: id: type: string description: ID of this User. firstName: type: string description: User's first name. lastName: type: string description: User's last name. username: type: string description: User's username. password: type: string description: User's password. emailAddress: type: string description: User's email address. phoneNumber: type: string description: User's phone number. emailLanguagePreference: type: string description: | User's preferred email language. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used. displayLanguagePreference: type: string description: | User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used. notifyUser: type: boolean description: | Indicates whether to send the user an email notification upon successful user creation. Defaults to false. sso: type: boolean description: | Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our [Implementing Single Sign-On](http://developer.yext.com/docs/guides/implementing-single-sign-on/) guide. Defaults to false. acl: type: array description: Entries in the access-control list. items: type: object required: - roleId - 'on' - accountId - onType properties: roleId: type: string description: The Yext Role ID. roleName: type: string description: The Role's Name 'on': type: string description: The ID of the account, folder, or entity that this role gives the user access to. accountId: type: string description: | The external ID of the account that contains the folder or entity that this role applies to. If ``onType`` is ``ACCOUNT``, the value of ``accountId`` must be the same as the value of ``on``. onType: type: string description: The type of object that this role gives the user access to. enum: - ACCOUNT - FOLDER - ENTITY externalIdentities: type: array description: An array of objects that have a source and an identities field. items: type: object required: - source - identities properties: source: type: string description: A unique string, no two source/identities field pairs for a single user can have the same source value. identities: type: array description: An array of strings. Multiple users can have the same (source, identity) pair(s). items: type: string CreateUserRequest: required: - id - firstName - lastName - emailAddress allOf: - $ref: '#/components/schemas/CreateUser' UpdateUser: type: object properties: id: type: string description: | ID of this User. Ignored when sent in update requests. firstName: type: string description: User's first name. lastName: type: string description: User's last name. username: type: string description: User's username. emailAddress: type: string description: User's email address. phoneNumber: type: string description: User's phone number. emailLanguagePreference: type: string description: | User's preferred email language. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the default language of the user's country will be used. displayLanguagePreference: type: string description: | User's preferred display language in the Yext platform. Must be a valid locale code (e.g., `en`, `en_UK`, `fr_FR`, `it`, etc.). If omitted or set to `null`, the browser's default language will be used. sso: type: boolean description: | Indicates whether SAML SSO has been enabled for this user. Omit this field if you are using Signed Link SSO. More information can be found in our [Implementing Single Sign-On](http://developer.yext.com/docs/guides/implementing-single-sign-on/) guide. Defaults to false. acl: type: array description: Entries in the access-control list. items: type: object required: - roleId - 'on' - accountId - onType properties: roleId: type: string description: The Yext Role ID. roleName: type: string description: The Role's Name. 'on': type: string description: The ID of the account, folder, or entity that this role gives the user access to. accountId: type: string description: | The external ID of the account that contains the folder or entity that this role applies to. If ``onType`` is ``ACCOUNT``, the value of ``accountId`` must be the same as the value of ``on``. onType: type: string description: The type of object that this role gives the user access to. enum: - ACCOUNT - FOLDER - ENTITY externalIdentities: type: array description: An array of objects that have a source and an identities field. items: type: object required: - source - identities properties: source: type: string description: A unique string, no two source/identities field pairs for a single user can have the same source value. identities: type: array description: An array of strings. Multiple users can have the same (source, identity) pair(s). items: type: string UpdateUserRequest: required: - id allOf: - $ref: '#/components/schemas/UpdateUser' UpdatePasswordRequest: type: object required: - newPassword properties: newPassword: type: string description: User's new password Account: type: object properties: accountId: type: string example: CUST-439843 locationCount: type: integer readOnly: true description: The number of locations in this account. subAccountCount: type: integer readOnly: true description: The number of sub-accounts directly under this account, if any. parentAccountId: type: string description: Customer-provided ID of the account that this is a sub-account of, if any. Not provided if this is a top-level account. accountName: type: string description: The name of this account. contactFirstName: type: string description: First name of the contact user for this account. contactLastName: type: string description: Last name of the contact user for this account. contactPhone: type: string description: Phone number of the contact user for this account. contactEmail: type: string description: Email address of the contact user for this account. ApprovalGroup: type: object properties: id: type: string description: Approval Group ID name: type: string description: Approval Group Name users: type: array description: Array of user IDs associated with the Approval Group items: type: string isDefault: type: boolean description: true if Approval Group is default for assignment of new tasks. Defaults to false. CreateApprovalGroupRequest: type: object required: - name properties: name: type: string description: Approval Group Name users: type: array description: Array of user ids associated with the Approval Group items: type: integer format: int32 isDefault: type: boolean description: True if Approval Group is default for assignment of new tasks. Defaults to false. LinkedAccount: type: object properties: id: type: string description: ID of the linked account. publisherId: type: string description: ID of the publisher associated with the linked account. entityIds: type: array items: type: string description: The entityId values for the entities the linked account is assigned to. firstName: type: string description: The first name of the linked account owner. lastName: type: string description: The last name of the linked account owner. email: type: string description: The email address associated with the linked account. status: type: string description: | The last known status of the account. * `VALID` * `INVALID` `VALID` The account's token is valid. `INVALID` The account’s token has expired and will not be successful when syncing to/from publishers. canAssign: type: boolean description: | Indicates whether a linked account can be assigned to subaccounts and/or entities within subaccounts. This field is only available for certain Yext accounts. OptimizationTask: type: object properties: id: type: string description: The Optimization Task’s ID name: type: string description: The name of the Optimization Task description: type: string description: Description of the Optimization Task locationsEligible: type: number description: The number of locations specified in the request that are eligible to have the task completed. locationsCompleted: type: number description: The number of locations specified in the request for which the task has been completed. 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. ComplexImageValue: type: object description: The content of the asset. properties: image: type: object required: - url additionalProperties: false properties: url: type: string minLength: 0 format: uri description: The image's URL. alternateText: type: string minLength: 0 description: Alternate text for the image (for accessibility purposes). description: type: string minLength: 0 description: A description of the image. clickthroughUrl: type: string minLength: 0 format: uri description: The URL users are directed to after clicking the image. AssetForComplexImage: allOf: - $ref: '#/components/schemas/Asset' - type: object properties: value: $ref: '#/components/schemas/ComplexImageValue' ComplexVideoValue: type: object description: The content of the asset. properties: video: type: object required: - url additionalProperties: false properties: url: type: string minLength: 0 format: uri description: The video's URL. description: type: string minLength: 0 description: A description of the video. AssetForComplexVideo: allOf: - $ref: '#/components/schemas/Asset' - type: object properties: value: $ref: '#/components/schemas/ComplexVideoValue' AssetForText: allOf: - $ref: '#/components/schemas/Asset' - type: object properties: value: type: string description: The content of the asset. 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`. 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`**. ConnectorRunResults: type: object required: - createdCount - updatedCount - deletedCount - failedCount - unchangedCount properties: createdCount: type: integer description: The number of successfully created entities. updatedCount: type: integer description: The number of successfully updated entities. deletedCount: type: integer description: The number of successfully deleted entities. failedCount: type: integer description: The number of entities that failed to be created or updated. unchangedCount: type: integer description: The number of entities that weren't updated. 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. For now, the only valid value here will be: * employee 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 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. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` name: minLength: 0 maxLength: 5000 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` address: additionalProperties: false type: object properties: city: minLength: 0 maxLength: 255 type: string description: |- The city the entity (or the entity's location) is in Cannot Include: * a URL or domain name Filtering Type: `text` countryCode: minLength: 0 pattern: ^[a-zA-Z]{2}$ type: string description: 'Filtering Type: `text`' extraDescription: minLength: 0 maxLength: 255 type: string description: |- Provides additional information to help consumers get to the entity. This string appears along with the entity's address (e.g., `In Menlo Mall, 3rd Floor`). It may also be used in conjunction with a hidden address (i.e., when **`addressHidden`** is `true`) to give consumers information about where the entity can be found (e.g., `Servicing the New York area`). Filtering Type: `text` line1: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` line2: minLength: 0 maxLength: 255 type: string description: |- Cannot Include: * a URL or domain name Filtering Type: `text` postalCode: minLength: 0 maxLength: 10 type: string description: |- The entity's postal code. The postal code must be valid for the entity's country. Cannot include a URL or domain name. Cannot Include: * a URL or domain name Filtering Type: `text` region: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's region or state. Cannot Include: * a URL or domain name Filtering Type: `text` sublocality: minLength: 0 maxLength: 255 type: string description: |- The name of the entity's sublocality Cannot Include: * a URL or domain name Filtering Type: `text` description: |- Contains the address of the entity (or where the entity is located) Must be a valid address Cannot be a P.O. Box If the entity is an `event`, either an **`address`** value or a **`linkedLocation`** value can be provided. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` acceptingNewPatients: type: boolean description: |- Indicates whether the healthcare provider is accepting new patients. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` acceptsReservations: type: boolean description: |- Indicates whether the entity accepts reservations. Filtering Type: `boolean` ``` Eligible For: * restaurant ``` accessHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the access hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the access hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of `accessHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday access hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * healthcareFacility * hotel * location * restaurant ``` additionalHoursText: minLength: 0 maxLength: 255 type: string description: |- Additional information about hours that does not fit in **`hours`** (e.g., `"Closed during the winter"`) Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` additionalPromotingLocations: description: |- If other locations are promoting this event, a list of those locations' **`id`**s in the Yext Knowledge Manager Array must be ordered. Filtering Type: `list of entityId` ``` Eligible For: * event ``` uniqueItems: true type: array items: type: string description: 'Filtering Type: `entityId`' addressHidden: type: boolean description: |- If `true`, the entity's street address will not be shown on listings. Defaults to `false`. Filtering Type: `boolean` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` admittingHospitals: description: |- A list of hospitals where the healthcare professional admits patients Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` adultPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a pool for adults only. Filtering Type: `option` ``` Eligible For: * hotel ``` ageRange: additionalProperties: false type: object properties: maxValue: multipleOf: 1 type: number description: |- Maximum age for the event Filtering Type: `integer` minValue: multipleOf: 1 type: number description: |- Minimum age for the event Filtering Type: `integer` description: |- Contains the age range for the event Filtering Type: `object` ``` Eligible For: * event ``` airportShuttle: enum: - AIRPORT_SHUTTLE_AVAILABLE - AIRPORT_SHUTTLE_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle to/from the airport. Filtering Type: `option` ``` Eligible For: * hotel ``` airportTransfer: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a shuttle service of car service to/from nearby airports or train stations. Filtering Type: `option` ``` Eligible For: * hotel ``` allInclusive: enum: - ALL_INCLUSIVE_RATES_AVAILABLE - ALL_INCLUSIVE_RATES_ONLY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers all-inclusive rates. Filtering Type: `option` ``` Eligible For: * hotel ``` alternateNames: description: |- Other names for your business that you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` alternatePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` alternateWebsites: description: |- Other websites for your business that we should search for when tracking your search performance Array must be ordered. Array may have a maximum of 3 elements. Array item description: >Cannot Include: >* common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 255 format: uri type: string description: |- Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` androidAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's Android app Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` answer: description: |- The answer to the frequently asked question represented by this entity Character limit: 0 .. 15000 Supported formats include: * BOLD * ITALICS * UNDERLINE * BULLETED_LIST * NUMBERED_LIST * HYPERLINK * IMAGE * CODE_SPAN * HEADINGS ``` Eligible For: * faq ``` type: string format: rich-text appleActionLinks: description: |- Use this field to add action links to your Apple Listings. The call to action category will be displayed on the action link button. The App Store URL should contain a valid link to the landing page of an App in the Apple App Store. The Quick Link URL is where a user is taken when an action link is clicked by a user. The App Name sub-field is not displayed on Apple Listings and is only used to distinguish the call-to-action type when utilizing action links in Apple posts. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - category - quickLinkUrl - appName additionalProperties: false type: object properties: appName: minLength: 0 maxLength: 18 type: string description: 'Filtering Type: `text`' appStoreUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' category: enum: - BOOK_TRAVEL - CHECK_IN - FEES_POLICIES - FLIGHT_STATUS - TICKETS - TICKETING - AMENITIES - FRONT_DESK - PARKING - GIFT_CARD - WAITLIST - DELIVERY - ORDER - TAKEOUT - PICKUP - RESERVE - MENU - APPOINTMENT - PORTFOLIO - QUOTE - SERVICES - STORE_ORDERS - STORE_SHOP - STORE_SUPPORT - SCHEDULE - SHOWTIMES - AVAILABILITY - PRICING - ACTIVITIES - BOOK - BOOK_(HOTEL) - BOOK_(RIDE) - BOOK_(TOUR) - CAREERS - CHARGE - COUPONS - DELIVERY_(RETAIL) - DONATE - EVENTS - ORDER_(RETAIL) - OTHER_MENU - PICKUP_(RETAIL) - RESERVE_(PARKING) - SHOWS - SPORTS - SUPPORT - TEE_TIME - GIFT_CARD_(RESTAURANT) type: string description: 'Filtering Type: `option`' quickLinkUrl: minLength: 0 maxLength: 2000 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' appleBusinessDescription: minLength: 0 maxLength: 500 type: string description: |- The business description to be sent to Apple Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleBusinessId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with an individual Business Folder in your Apple account Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCompanyId: minLength: 0 pattern: ^\d*\.?\d*$ type: string description: |- The ID associated with your Apple account. Numerical values only Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` appleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity''s Apple profile Image must be at least 1600 x 1040 pixels Image may be no more than 4864 x 3163 pixels Supported Aspect Ratios: * 154 x 100 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' appleDisplayName: minLength: 0 maxLength: 5000 type: string description: |- The name to be displayed on Apple for the entity. NOTE: The names of Brands and their respective Locations within an Apple Business Connect Account must match identically. Cannot Include: HTML markup Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` applicationUrl: minLength: 0 format: uri type: string description: |- The application URL Filtering Type: `text` ``` Eligible For: * job ``` associations: description: |- Association memberships relevant to the entity (e.g., `"New York Doctors Association"`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` attendance: required: - attendanceMode additionalProperties: false type: object properties: attendanceMode: enum: - OFFLINE - ONLINE - MIXED type: string description: 'Filtering Type: `option`' virtualLocationUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: |- Indicates whether the event is online, offline, or a mix. A `virtualLocationUrl` must be specified for online and mixed events. Filtering Type: `object` ``` Eligible For: * event ``` attire: enum: - UNSPECIFIED - DRESSY - CASUAL - FORMAL type: string description: |- The formality of clothing typically worn at this restaurant Filtering Type: `option` ``` Eligible For: * restaurant ``` babysittingOffered: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers babysitting. Filtering Type: `option` ``` Eligible For: * hotel ``` baggageStorage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers baggage storage pre check-in and post check-out. Filtering Type: `option` ``` Eligible For: * hotel ``` bar: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an indoor or outdoor bar onsite. Filtering Type: `option` ``` Eligible For: * hotel ``` beachAccess: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` beachFrontProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is physically located next to a beach. Filtering Type: `option` ``` Eligible For: * hotel ``` bicycles: enum: - BICYCLE_RENTALS - BICYCLE_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers bicycles for rent or for free. Filtering Type: `option` ``` Eligible For: * hotel ``` bios: additionalProperties: false type: object properties: ids: description: |- IDs of the Bio Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Bio Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Bio Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` boutiqueStores: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a boutique store. Gift shop or convenience store are not eligible. Filtering Type: `option` ``` Eligible For: * hotel ``` brands: description: |- Brands sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` breakfast: enum: - BREAKFAST_AVAILABLE - BREAKFAST_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers breakfast. Filtering Type: `option` ``` Eligible For: * hotel ``` brunchHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the brunch hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for brunch on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of `brunchHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday brunch hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` businessCenter: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a business center. Filtering Type: `option` ``` Eligible For: * hotel ``` calendars: additionalProperties: false type: object properties: ids: description: |- IDs of the Calendars associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Calendars. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the events Content Lists (Calendars) associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * hotel * location * restaurant ``` carRental: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers car rental. Filtering Type: `option` ``` Eligible For: * hotel ``` casino: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a casino on premise or nearby. Filtering Type: `option` ``` Eligible For: * hotel ``` categories: additionalProperties: false type: object properties: {} description: |- Yext Categories. (Supported for versions > 20240220) A map of category list external IDs (i.e. "yext") to a list of category IDs. IDs must be valid and selectable (i.e., cannot be parent categories). Partial updates are accepted, meaning sending only the "yext" property will have no effect on any category list except the "yext" category. Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` categoryIds: uniqueItems: false type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' description: |- Yext Category IDs. (Deprecated: For versions > 20240220) IDs must be valid and selectable (i.e., cannot be parent categories). NOTE: The list of category IDs that you send us must be comprehensive. For example, if you send us a list of IDs that does not include IDs that you sent in your last update, Yext considers the missing categories to be deleted, and we remove them from your listings. Filtering Type: `list of text` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` catsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is cat friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` certifications: description: |- A list of the certifications held by the healthcare professional **NOTE:** This field is only available to locations whose **`entityType`** is `healthcareProfessional`. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 200 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` checkInTime: format: time type: string description: |- The check-in time Filtering Type: `time` ``` Eligible For: * hotel ``` checkOutTime: format: time type: string description: |- The check-out time Filtering Type: `time` ``` Eligible For: * hotel ``` classificationRating: pattern: ^\d*\.?\d*$ type: string description: |- The 1 to 5 star rating of the entitiy based on its services and facilities. Filtering Type: `decimal` ``` Eligible For: * hotel ``` closed: type: boolean description: |- Indicates whether the entity is closed Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` concierge: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers concierge service. Filtering Type: `option` ``` Eligible For: * hotel ``` conditionsTreated: description: |- A list of the conditions treated by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` convenienceStore: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a convenience store. Filtering Type: `option` ``` Eligible For: * hotel ``` covidMessaging: minLength: 0 maxLength: 15000 type: string description: |- Information or messaging related to COVID-19. Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional * location ``` covidTestAppointmentUrl: minLength: 0 format: uri type: string description: |- An appointment URL for scheduling a COVID-19 test. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidTestingAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 test. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 tests. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingIsFree: type: boolean description: |- Indicates whether location offers free COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingPatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingReferralRequired: type: boolean description: |- Indicates whether a referral is required for COVID-19 testing. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidTestingSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 testing site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccineAppointmentRequired: type: boolean description: |- Indicates whether an appointment is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineDriveThroughSite: type: boolean description: |- Indicates whether location is a drive-through site for COVID-19 vaccines. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineInformationUrl: minLength: 0 format: uri type: string description: |- An information URL for more information about COVID-19 vaccines. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinePatientRestrictions: type: boolean description: |- Indicates whether there are patient restrictions for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineReferralRequired: type: boolean description: |- Indicates whether a referral is required for a COVID-19 vaccine. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * location ``` covidVaccineSiteInstructions: minLength: 0 maxLength: 15000 type: string description: |- Information or instructions for the COVID-19 vaccination site. Filtering Type: `text` ``` Eligible For: * healthcareFacility * location ``` covidVaccinesOffered: uniqueItems: true type: array items: enum: - PFIZER - MODERNA - JOHNSON_&_JOHNSON type: string description: 'Filtering Type: `option`' description: |- Indicates which COVID-19 vaccines the location offers. Filtering Type: `list of option` ``` Eligible For: * healthcareFacility * location ``` currencyExchange: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers currency exchange services. Filtering Type: `option` ``` Eligible For: * hotel ``` customKeywords: description: |- Additional keywords you would like us to use when tracking your search performance Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' datePosted: format: date type: string description: |- The date this entity was posted Filtering Type: `date` ``` Eligible For: * job ``` degrees: description: |- A list of the degrees earned by the healthcare professional Array must be ordered. Filtering Type: `list of option` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: enum: - ANP - APN - APRN - ARNP - AUD - BSW - CCCA - CNM - CNP - CNS - CPNP - CRNA - CRNP - DC - DDS - DMD - DNP - DO - DPM - DPT - DSW - DVM - FNP - GNP - LAC - LCSW - LPN - MBA - MBBS - MD - MPAS - MPH - MSW - ND - NNP - NP - OD - PA - PAC - PHARMD - PHD - PNP - PSYD - RD - RSW - VMD - WHNP type: string description: 'Filtering Type: `option`' deliveryHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the delivery hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is delivering on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of `deliveryHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday delivery hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` description: minLength: 10 maxLength: 15000 type: string description: |- A description of the entity Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` displayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` doctorOnCall: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a doctor on premise or on call. Filtering Type: `option` ``` Eligible For: * hotel ``` dogsAllowed: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is dog friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` driveThroughHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the drive-through hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's drive-through is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of `driveThroughHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday drive-through hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * location * restaurant ``` dropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of the drop-off area for the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` educationList: description: |- Information about the education or training completed by the healthcare professional Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * healthcareProfessional ``` uniqueItems: true type: array items: required: - type - institutionName - yearCompleted additionalProperties: false type: object properties: institutionName: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' type: enum: - FELLOWSHIP - RESIDENCY - INTERNSHIP - MEDICAL_SCHOOL type: string description: 'Filtering Type: `option`' yearCompleted: multipleOf: 1 minimum: 1900 maximum: 2100 type: number description: 'Filtering Type: `integer`' description: 'Filtering Type: `object`' electricChargingStation: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has electric car chargine stations on premise. Filtering Type: `option` ``` Eligible For: * hotel ``` elevator: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elevator. Filtering Type: `option` ``` Eligible For: * hotel ``` ellipticalMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has an elliptical machine. Filtering Type: `option` ``` Eligible For: * hotel ``` emails: description: |- Emails addresses for this entity's point of contact Must be valid email addresses Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: minLength: 0 format: email type: string description: 'Filtering Type: `text`' employmentType: enum: - FULL_TIME - PART_TIME - CONTRACTOR - TEMPORARY - INTERN - VOLUNTEER - PER_DIEM - OTHER type: string description: |- The employment type for the open job. Indicates whether the job is full-time, part-time, temporary, etc. Filtering Type: `option` ``` Eligible For: * job ``` eventStatus: enum: - SCHEDULED - RESCHEDULED - POSTPONED - CANCELED - EVENT_MOVED_ONLINE type: string description: |- Information on whether the event will take place as scheduled Filtering Type: `option` ``` Eligible For: * event ``` facebookAbout: minLength: 0 maxLength: 255 type: string description: |- A description of the entity to be used in the "About You" section on Facebook Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCallToAction: required: - type additionalProperties: false type: object properties: type: enum: - NONE - BOOK_NOW - CALL_NOW - CONTACT_US - SEND_MESSAGE - USE_APP - PLAY_GAME - SHOP_NOW - SIGN_UP - WATCH_VIDEO - SEND_EMAIL - LEARN_MORE - PURCHASE_GIFT_CARDS - ORDER_NOW - FOLLOW_PAGE type: string description: |- The action the consumer is being prompted to take by the button's text Filtering Type: `option` value: minLength: 0 type: string description: |- Indicates where consumers will be directed to upon clicking the Call-to-Action button (e.g., a URL). It can be a free-form string or an embedded value, depending on what the user specifies. For example, if the user sets the Facebook Call-to-Action as " 'Sign Up' using 'Website URL' " in the Yext platform, **`type`** will be `SIGN_UP` and **`value`** will be `[[websiteUrl]]`. The Call-to-Action will have the same behavior if the user sets the value to "Custom Value" in the platform and embeds a field. Filtering Type: `text` description: |- Designates the Facebook Call-to-Action button text and value Valid contents of **`value`** depends on the Call-to-Action's **`type`**: * `NONE`: (optional) * `BOOK_NOW`: URL * `CALL_NOW`: Phone number * `CONTACT_US`: URL * `SEND_MESSAGE`: Any string * `USE_APP`: URL * `PLAY_GAME`: URL * `SHOP_NOW`: URL * `SIGN_UP`: URL * `WATCH_VIDEO`: URL * `SEND_EMAIL`: Email address * `LEARN_MORE`: URL * `PURCHASE_GIFT_CARDS`: URL * `ORDER_NOW`: URL * `FOLLOW_PAGE`: Any string Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Facebook profile Displayed as a 851 x 315 pixel image You may need a cover photo in order for your listing to appear on Facebook. Please check your listings tab to learn more. Image must be at least 400 x 150 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookDescriptor: minLength: 3 maxLength: 75 type: string description: |- Location Descriptors are used for Enterprise businesses that sync Facebook listings using brand page location structure. The Location Descriptor is typically an additional geographic description (e.g. geomodifier) that will appear in parentheses after the name on the Facebook listing. Cannot Include: * HTML markup Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookName: minLength: 0 type: string description: |- The name for this entity's Facebook profile. A separate name may be specified to send only to Facebook in order to comply with any specific Facebook rules or naming conventions. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookOverrideCity: minLength: 0 type: string description: |- The city to be displayed on this entity's Facebook profile Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookPageUrl: minLength: 0 type: string description: |- URL for the entity's Facebook Page. Valid formats: - facebook.com/profile.php?id=[numId] - facebook.com/group.php?gid=[numId] - facebook.com/groups/[numId] - facebook.com/[Name] - facebook.com/pages/[Name]/[numId] - facebook.com/people/[Name]/[numId] where [Name] is a String and [numId] is an Integer The success response will contain a warning message explaining why the URL wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` facebookParentPageId: minLength: 0 maxLength: 65 type: string description: |- The Facebook Page ID of this entity's brand page if in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * brand * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile picture for the entity's Facebook profile You must have a profile picture in order for your listing to appear on Facebook. Image must be at least 180 x 180 pixels Image area (width x height) may be no more than 41000000 pixels Image may be no more than 30000 x 30000 pixels Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' facebookStoreId: minLength: 0 type: string description: |- The Store ID used for this entity in a brand page location structure Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookVanityUrl: minLength: 0 maxLength: 50 type: string description: |- The username that appear's in the Facebook listing URL to help customers find and remember a brand’s Facebook page. The username is also be used for tagging the Facebook page in other users’ posts, and searching for the Facebook page. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` facebookWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Facebook in place of the one given in **`websiteUrl`** (if applicable). Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fax: minLength: 0 type: string description: |- Must be a valid fax number. If the fax number's calling code is for a country other than the one given in the entity's **`countryCode`**, the fax number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` featuredMessage: additionalProperties: false type: object properties: description: minLength: 0 maxLength: 50 type: string description: |- The text of Featured Message. Default: `Call today!` Cannot include: - inappropriate language - HTML markup - a URL or domain name - a phone number - control characters ([\x00-\x1F\x7F]) - insufficient spacing If you submit a Featured Message that contains profanity or more than 50 characters, it will be ignored. The success response will contain a warning message explaining why your Featured Message wasn't stored in the system. Cannot Include: * HTML markup Filtering Type: `text` url: minLength: 0 maxLength: 255 format: uri type: string description: |- Valid URL linked to the Featured Message text Filtering Type: `text` description: |- Information about the entity's Featured Message Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` firstName: minLength: 0 maxLength: 35 type: string description: |- The first name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` firstPartyReviewPage: minLength: 0 type: string description: |- Link to the review-collection page, where consumers can leave first-party reviews ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` fitnessCenter: enum: - FITNESS_CENTER_AVAILABLE - FITNESS_CENTER_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a fitness center. Filtering Type: `option` ``` Eligible For: * hotel ``` floorCount: multipleOf: 1 minimum: 0 type: number description: |- The number of floors the entity has from ground floor to top floor. Filtering Type: `integer` ``` Eligible For: * hotel ``` freeWeights: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has free weights. Filtering Type: `option` ``` Eligible For: * hotel ``` frequentlyAskedQuestions: description: |- A list of questions that are frequently asked about this entity Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: required: - question additionalProperties: false type: object properties: answer: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' question: minLength: 1 maxLength: 4096 type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' frontDesk: enum: - FRONT_DESK_AVAILABLE - FRONT_DESK_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a front desk. Filtering Type: `option` ``` Eligible For: * hotel ``` fullyVaccinatedStaff: type: boolean description: |- Indicates whether the staff is vaccinated against COVID-19. Filtering Type: `boolean` ``` Eligible For: * healthcareFacility * hotel * location * restaurant ``` gameRoom: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a game room. Filtering Type: `option` ``` Eligible For: * hotel ``` gender: enum: - UNSPECIFIED - FEMALE - MALE - NONBINARY - TRANSGENDER_FEMALE - TRANSGENDER_MALE - OTHER - PREFER_NOT_TO_DISCLOSE type: string description: |- The gender of the healthcare professional Filtering Type: `option` ``` Eligible For: * healthcareProfessional ``` geomodifier: minLength: 0 type: string description: |- Provides additional information on where the entity can be found (e.g., `Times Square`, `Global Center Mall`) Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` giftShop: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a gift shop. Filtering Type: `option` ``` Eligible For: * hotel ``` golf: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a golf couse on premise or nearby. The golf course may be independently run. Filtering Type: `option` ``` Eligible For: * hotel ``` googleAttributes: additionalProperties: false type: object properties: {} description: |- The unique IDs of the entity's Google Business Profile keywords, as well as the unique IDs of any values selected for each keyword. Valid keywords (e.g., `has_drive_through`, `has_fitting_room`, `kitchen_in_room`) are determined by the entity's primary category. A full list of keywords can be retrieved with the Google Fields: List endpoint. Keyword values provide more details on how the keyword applies to the entity (e.g., if the keyword is `has_drive_through`, its values may be `true` or `false`). * If the **`v`** parameter is before `20181204`: **`googleAttributes`** is formatted as a map of key-value pairs (e.g., `[{ "id": "has_wheelchair_accessible_entrance", "values": [ "true" ] }]`) * If the **`v`** parameter is on or after `20181204`: the contents are formatted as a list of objects (e.g., `{ "has_wheelchair_accessible_entrance": [ "true" ]}`) **NOTE:** The latest Google Attributes are available via the Google Fields: List endpoint. Google Attributes are managed by Google and are subject to change without notice. To prevent errors, make sure your API implementation is not dependent on the presence of specific attributes. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleCoverPhoto: required: - url additionalProperties: false type: object description: |- The cover photo for the entity's Google profile Image must be at least 250 x 250 pixels Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleMessaging: additionalProperties: false type: object properties: smsNumber: minLength: 0 type: string description: |- The SMS phone number of the entity's point of contact for messaging/ chat functionality. Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's countryCode, the phone number provided must contain the calling code (e.g., +44 in +442038083831). Otherwise, the calling code is optional. Filtering Type: `text` whatsappMessagingUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's WhatsApp account. Must be a valid URL Filtering Type: `text` description: |- Information about Google Messaging, WhatsApp and SMS, for the entity’s point of contact for messaging/chat functionality. NOTE: Only one, either WhatsApp or SMS is displayed on the Google listing. If both SMS Number and WhatsApp URL are provided only SMS Number will be displayed on the listing. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleMyBusinessLabels: description: |- Google Business Profile Labels help users organize their locations into groups within GBP. Array must be ordered. Array may have a maximum of 10 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 50 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` googlePlaceId: minLength: 0 type: string description: |- The unique identifier of this entity on Google Maps. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` googleProfilePhoto: required: - url additionalProperties: false type: object description: |- The profile photo for the entity's Google profile Image must be at least 250 x 250 pixels Image may be no more than 5000 x 5000 pixels Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' googleWebsiteOverride: minLength: 0 format: uri type: string description: |- The URL you would like to submit to Google Business Profile in place of the one given in **`websiteUrl`** (if applicable). For example, if you want to analyze the traffic driven by your Google listings separately from other traffic, enter the alternate URL that you will use for tracking in this field. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` happyHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's happy hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the happy hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's happy hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of `happyHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday happy hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` headshot: required: - url additionalProperties: false type: object description: |- A portrait of the healthcare professional Filtering Type: `object` ``` Eligible For: * contactCard * financialProfessional * healthcareProfessional ``` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' hiringOrganization: minLength: 0 type: string description: |- The organization that is hiring for the open job Filtering Type: `text` ``` Eligible For: * job ``` holidayHoursConversationEnabled: type: boolean description: |- Indicates whether holiday-hour confirmation alerts are enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` horsebackRiding: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers horseback riding. Filtering Type: `option` ``` Eligible For: * hotel ``` hotTub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a hot tub. Filtering Type: `option` ``` Eligible For: * hotel ``` hours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the hours of operation are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily hours, holiday hours, and reopen date for the Entity. Each day is represented by a sub-field of `hours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` housekeeping: enum: - HOUSEKEEPING_AVAILABLE - HOUSEKEEPING_AVAILABLE_DAILY - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers housekeeping services. Filtering Type: `option` ``` Eligible For: * hotel ``` impressum: minLength: 0 maxLength: 2000 type: string description: |- A statement of the ownership and authorship of a document. Individuals or organizations based in many German-speaking countries are required by law to include an Impressum in published media. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` indoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- A count of the number of indoor pools Filtering Type: `integer` ``` Eligible For: * hotel ``` instagramHandle: minLength: 0 maxLength: 30 type: string description: |- Valid Instagram username for the entity without the leading "@" (e.g., `NewCityAuto`) Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` insuranceAccepted: description: |- A list of insurance policies accepted by the healthcare provider Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` iosAppUrl: minLength: 0 type: string description: |- The URL where consumers can download the entity's app to their iPhone or iPad Filtering Type: `text` ``` Eligible For: * brand * financialProfessional * hotel * location * restaurant ``` isClusterPrimary: type: boolean description: |- Indicates whether the healthcare entity is the primary entity in its group Filtering Type: `boolean` ``` Eligible For: * healthcareProfessional ``` isFreeEvent: type: boolean description: |- Indicates whether or not the event is free Filtering Type: `boolean` ``` Eligible For: * event ``` isoRegionCode: minLength: 0 type: string description: |- The ISO 3166-2 region code for the entity Yext will determine the entity's code and update **`isoRegionCode`** with that value. If Yext is unable to determine the code for the entity, the entity'ss ISO 3166-1 alpha-2 country code will be used. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` keywords: description: |- Keywords that describe the entity. All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` kidFriendly: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is kid friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsClub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a Kids Club. Filtering Type: `option` ``` Eligible For: * hotel ``` kidsStayFree: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity allows kids to stay free. Filtering Type: `option` ``` Eligible For: * hotel ``` kitchenHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen open on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the kitchen hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity's kitchen is open on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of `kitchenHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday kitchen hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * hotel * location * restaurant ``` labels: uniqueItems: false type: array items: minLength: 0 type: string description: |- The IDs of the entity labels that have been added to this entity. Entity labels help you identify entities that share a certain characteristic; they do not appear on your entity's listings. **NOTE:** You can only add labels that have already been created via our web interface. Currently, it is not possible to create new labels via the API. Filtering Type: `opaque` ``` Eligible For: * atm * board * brand * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` landingPageUrl: minLength: 0 format: uri type: string description: |- The URL of this entity's Landing Page that was created with Yext Pages Filtering Type: `text` ``` Eligible For: * atm * card * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * product * restaurant ``` languages: description: |- The langauges in which consumers can commicate with this entity or its staff members All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` lastName: minLength: 0 maxLength: 35 type: string description: |- The last name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` laundry: enum: - FULL_SERVICE - SELF_SERVICE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers laundry services. Filtering Type: `option` ``` Eligible For: * hotel ``` lazyRiver: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lazy river Filtering Type: `option` ``` Eligible For: * hotel ``` lifeguard: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the property has a lifeguard on duty Filtering Type: `option` ``` Eligible For: * hotel ``` linkedInUrl: minLength: 0 format: uri type: string description: |- URL for your LinkedIn account, format should be https://www.linkedin.com/in/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` linkedLocation: type: string description: |- location ID of the event location, if the event is held at a location managed in the Yext Knowledge Manager Filtering Type: `entityId` ``` Eligible For: * contactCard * event ``` localPhone: minLength: 0 type: string description: |- Must be a valid, non-toll-free phone number, based on the country specified in **`address.region`**. Phone numbers for US entities must contain 10 digits. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` localShuttle: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers local shuttle services. Filtering Type: `option` ``` Eligible For: * hotel ``` locatedIn: type: string description: |- For atms, the external ID of the entity that the atm is installed in. The entity must be in the same business account as the atm. Filtering Type: `entityId` ``` Eligible For: * atm ``` location: additionalProperties: false type: object properties: existingLocation: type: string description: |- A location entity referenced by Yext ID or Entity ID where this job opening exists Filtering Type: `entityId` externalLocation: minLength: 0 maxLength: 255 type: string description: |- A location string where this job opening exists Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` description: |- The location where this job opening exists as either an existing location or an external location Filtering Type: `object` ``` Eligible For: * job ``` locationType: enum: - LOCATION - HEALTHCARE_FACILITY - HEALTHCARE_PROFESSIONAL - ATM - RESTAURANT - HOTEL type: string description: |- Indicates the entity's type, if it is not an event Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` logo: required: - image additionalProperties: false type: object description: |- An image of the entity's logo Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` ``` Eligible For: * atm * contactCard * faq * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * organization * restaurant ``` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' mainPhone: minLength: 0 type: string description: |- The main phone number of the entity's point of contact Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` massage: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers massage services. Filtering Type: `option` ``` Eligible For: * hotel ``` maxAgeOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum age specified by the property for children to stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` maxNumberOfKidsStayFree: multipleOf: 1 minimum: 0 type: number description: |- The maximum number of children who can stay in the room/suite of a parent or adult without an additional fee Filtering Type: `integer` ``` Eligible For: * hotel ``` mealsServed: uniqueItems: true type: array items: enum: - BREAKFAST - LUNCH - BRUNCH - DINNER - HAPPY_HOUR - LATE_NIGHT type: string description: 'Filtering Type: `option`' description: |- Types of meals served at this restaurant Filtering Type: `list of option` ``` Eligible For: * restaurant ``` meetingRoomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of meeting rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` menuUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`menuUrl.url`**. You can use **`menuUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`menuUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL where consumers can view the entity's menu Filtering Type: `text` description: |- Information about the URL where consumers can view the entity's menu Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` menus: additionalProperties: false type: object properties: ids: description: |- IDs of the Menu Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Menu Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Menu Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * hotel * location * restaurant ``` middleName: minLength: 0 maxLength: 35 type: string description: |- The middle name of the healthcare professional Cannot Include: * a URL or domain name * HTML markup Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` mobilePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` mobilityAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity is mobility/wheelchair accessible Filtering Type: `option` ``` Eligible For: * hotel ``` nightclub: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a nightclub. Filtering Type: `option` ``` Eligible For: * hotel ``` npi: minLength: 0 type: string description: |- The National Provider Identifier (NPI) of the healthcare provider Filtering Type: `text` ``` Eligible For: * healthcareFacility * healthcareProfessional ``` nudgeEnabled: type: boolean description: |- Indicates whether Knowledge Nudge is enabled for the Yext Knowledge Assistant for this entity Filtering Type: `boolean` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` officeName: minLength: 0 type: string description: |- The name of the office where the healthcare professional works, if different from **`name`** Filtering Type: `text` ``` Eligible For: * healthcareProfessional ``` onlineServiceHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the online service hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's online service hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of `onlineServiceHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday online service hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * location * restaurant ``` openDate: format: date type: string description: |- The date that the entity is set to open for the first time. Must be formatted in YYYY-MM-DD format. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` operatingCountries: uniqueItems: true type: array items: enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NG - NI - NL - 'NO' - NP - NR - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XK - YE - YT - ZA - ZM - ZW type: string description: 'Filtering Type: `option`' description: |- The list of countries the business operates in Filtering Type: `list of option` ``` Eligible For: * organization ``` orderUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`orderUrl.url`**. You can use **`orderUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`orderUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to place an order at this entity Filtering Type: `text` description: |- Information about the URL used to place orders that will be fulfilled by the entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` organizerEmail: minLength: 0 format: email type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerName: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` organizerPhone: minLength: 0 type: string description: |- Point of contact for the event organizer (not to be published publicly) Filtering Type: `text` ``` Eligible For: * event ``` outdoorPoolCount: multipleOf: 1 minimum: 0 type: number description: |- The number of outdoor pools the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` parking: enum: - PARKING_AVAILABLE - PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` paymentOptions: uniqueItems: true type: array items: enum: - AFTERPAY - ALIPAY - AMERICANEXPRESS - ANDROIDPAY - APPLEPAY - ATM - ATMQUICK - BACS - BANCONTACT - BANKDEPOSIT - BANKPAY - BGO - BITCOIN - Bar - CARTASI - CASH - CCS - CHECK - CHEQUESVACANCES - CONB - CONTACTLESSPAYME - CVVV - DEBITCARD - DEBITNOTE - DINERSCLUB - DIRECTDEBIT - DISCOVER - ECKARTE - ECOCHEQUE - EKENA - EMV - FINANCING - GIFTCARD - GOPAY - HAYAKAKEN - HEBAG - IBOD - ICCARDS - ICOCA - ID - IDEAL - INCA - INVOICE - JCB - JCoinPay - JKOPAY - KITACA - KLA - KLARNA - LINEPAY - MAESTRO - MANACA - MASTERCARD - MIPAY - MONIZZE - MPAY - Manuelle Lastsch - Merpay - NANACO - NEXI - NIMOCA - OREM - PASMO - PAYBACKPAY - PAYBOX - PAYCONIQ - PAYPAL - PAYPAY - PAYSEC - PIN - POSTEPAY - QRCODE - QUICPAY - RAKUTENEDY - RAKUTENPAY - SAMSUNGPAY - SODEXO - SUGOCA - SUICA - SWISH - TICKETRESTAURANT - TOICA - TRAVELERSCHECK - TSCUBIC - TWINT - UNIONPAY - VEV - VISA - VISAELECTRON - VOB - VOUCHER - VPAY - WAON - WECHATPAY - WIRETRANSFER - Yucho Pay - ZELLE - auPay - dBarai - Überweisung type: string description: 'Filtering Type: `option`' description: |- The payment methods accepted by this entity Valid elements depend on the entity's country. Filtering Type: `list of option` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` performers: description: |- Performers at the event Array must be ordered. Array may have a maximum of 100 elements. Filtering Type: `list of text` ``` Eligible For: * event ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' petsAllowed: enum: - PETS_WELCOME - PETS_WELCOME_FOR_FREE - NOT_APPLICABLE - NOT_ALLOWED type: string description: |- Indicates if the entity is pet friendly. Filtering Type: `option` ``` Eligible For: * hotel ``` photoGallery: description: |- **NOTE:** The list of photos that you send us must be comprehensive. For example, if you send us a list of photos that does not include photos that you sent in your last update, Yext considers the missing photos to be deleted, and we remove them from your listings. Array must be ordered. Array may have a maximum of 500 elements. Array item description: >Supported Aspect Ratios: >* 1 x 1 >* 4 x 3 >* 3 x 2 >* 5 x 3 >* 16 x 9 >* 3 x 1 >* 2 x 3 >* 5 x 7 >* 4 x 5 >* 4 x 1 > >**NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. > Filtering Type: `list of object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: false type: array items: required: - image additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: clickthroughUrl: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: minLength: 0 type: string description: 'Filtering Type: `text`' details: minLength: 0 type: string description: 'Filtering Type: `text`' image: required: - url additionalProperties: false type: object description: |- Supported Aspect Ratios: * 1 x 1 * 4 x 3 * 3 x 2 * 5 x 3 * 16 x 9 * 3 x 1 * 2 x 3 * 5 x 7 * 4 x 5 * 4 x 1 **NOTE**: Maximum image size is 5mb after normalization and padding (if applicable). As well, there is a 6 second download limit from the image host. Filtering Type: `object` properties: alternateText: minLength: 0 type: string description: 'Filtering Type: `text`' url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' pickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` pickupHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the pickup hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for pickup on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of `pickupHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday pickup hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * healthcareFacility * location * restaurant ``` pinterestUrl: minLength: 0 format: uri type: string description: |- URL for your Pinterest account, format should be https://www.pinterest.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` priceRange: enum: - UNSPECIFIED - ONE - TWO - THREE - FOUR type: string description: |- he typical price of products sold by this location, on a scale of 1 (low) to 4 (high) Filtering Type: `option` ``` Eligible For: * atm * healthcareFacility * healthcareProfessional * location * restaurant ``` primaryConversationContact: minLength: 0 type: string description: |- ID of the user who is the primary Knowledge Assistant contact for the entity Filtering Type: `option` ``` Eligible For: * atm * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * job * location * organization * product * restaurant ``` privateBeach: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has access to a private beach. Filtering Type: `option` ``` Eligible For: * hotel ``` privateCarService: enum: - PRIVATE_CAR_SERVICE - PRIVATE_CAR_SERVICE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers private car services. Filtering Type: `option` ``` Eligible For: * hotel ``` productLists: additionalProperties: false type: object properties: ids: description: |- IDs of the Products & Services Lists associated with this entity Array must be ordered. Array may have a maximum of 40 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 type: string description: 'Filtering Type: `text`' label: minLength: 0 maxLength: 30 type: string description: |- Label to be used for this entity's Products & Services Lists. This label will appear on your entity's listings. Filtering Type: `text` description: |- Information about the Products & Services Content Lists associated with this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` products: description: |- Products sold by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` questionsAndAnswers: type: boolean description: |- Indicates whether Yext Knowledge Assistant question-and-answer conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingCompetitors: description: |- Information about the competitors whose search performance you would like to compare to your own Array must be ordered. Array may have a maximum of 5 elements. Filtering Type: `list of object` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: required: - name - website additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: |- A name of a competitor Cannot Include: * HTML markup Filtering Type: `text` website: minLength: 0 maxLength: 255 format: uri type: string description: |- The business website of a competitor Cannot Include: * common domain names, e.g., google.com, youtube.com, etc. Filtering Type: `text` description: 'Filtering Type: `object`' rankTrackingEnabled: type: boolean description: |- Indicates whether Rank Tracking is enabled Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingFrequency: enum: - WEEKLY - MONTHLY - QUARTERLY type: string description: |- How often we send search queries to track your search performance Filtering Type: `option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` rankTrackingQueryTemplates: description: |- The ways in which your keywords will be arranged in the search queries we use to track your performance Array must have a minimum of 2 elements. Array may have a maximum of 4 elements. Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uniqueItems: true type: array items: enum: - KEYWORD - KEYWORD_ZIP - KEYWORD_CITY - KEYWORD_IN_CITY - KEYWORD_NEAR_ME - KEYWORD_CITY_STATE type: string description: 'Filtering Type: `option`' rankTrackingSites: uniqueItems: true type: array items: enum: - GOOGLE_DESKTOP - GOOGLE_MOBILE - BING_DESKTOP - BING_MOBILE - YAHOO_DESKTOP - YAHOO_MOBILE type: string description: 'Filtering Type: `option`' description: |- The search engines that we will use to track your performance Filtering Type: `list of option` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` reservationUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`reservationUrl.url`**. You can use **`reservationUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`reservationUrl.url`**. Must be a valid URL and be specified along with **`reservationUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL used to make reservations at this entity Filtering Type: `text` description: |- Information about the URL consumers can visit to make reservations at this entity Filtering Type: `object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` restaurantCount: multipleOf: 1 minimum: 0 type: number description: |- The number of restaurants the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` reviewGenerationUrl: minLength: 0 type: string description: |- The URL given Review Invitation emails where consumers can leave a review about the entity ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` reviewResponseConversationEnabled: type: boolean description: |- Indicates whether Yext Knowledge Assistant review-response conversations are enabled for this entity Filtering Type: `boolean` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` roomCount: multipleOf: 1 minimum: 0 type: number description: |- The number of rooms the entity has. Filtering Type: `integer` ``` Eligible For: * hotel ``` roomService: enum: - ROOM_SERVICE_AVAILABLE - ROOM_SERVICE_AVAILABLE_24_HOURS - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers room service. Filtering Type: `option` ``` Eligible For: * hotel ``` routableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` salon: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a salon. Filtering Type: `option` ``` Eligible For: * hotel ``` sauna: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sauna. Filtering Type: `option` ``` Eligible For: * hotel ``` scuba: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers scuba diving. Filtering Type: `option` ``` Eligible For: * hotel ``` selfParking: enum: - SELF_PARKING_AVAILABLE - SELF_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers self parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` seniorHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the senior hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for the Entity's senior hours on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of `seniorHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday senior hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` serviceArea: additionalProperties: false type: object properties: places: description: |- A list of places served by the entity, where each place is either: - a postal code, or - the name of a city. Array must be ordered. Array may have a maximum of 200 elements. Filtering Type: `list of text` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' description: |- Information about the area that is served by this entity. It is specified as a list of cities and/or postal codes. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` serviceAreaPlaces: description: |- Information about the area that is served by this entity. It is specified as a list of service area names, their associated types and google place ids. **Only for Google Business Profile and Bing:** Currently, **serviceArea** is only supported by Google Business Profile and Bing and will not affect your listings on other sites. Array may have a maximum of 200 elements. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: additionalProperties: false type: object properties: name: minLength: 0 maxLength: 100 type: string description: 'Filtering Type: `text`' googlePlaceId: minLength: 0 type: string description: 'Filtering Type: `text`' type: enum: - POSTAL_CODE - REGION - COUNTY - CITY - SUBLOCALITY type: string description: 'Filtering Type: `option`' description: 'Filtering Type: `object`' services: description: |- Services offered by this entity All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` smokeFreeProperty: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is smoke free. Filtering Type: `option` ``` Eligible For: * hotel ``` snorkeling: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers snorkeling. Filtering Type: `option` ``` Eligible For: * hotel ``` socialHour: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers a social hour. Filtering Type: `option` ``` Eligible For: * hotel ``` spa: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a spa. Filtering Type: `option` ``` Eligible For: * hotel ``` specialities: description: |- Up to 100 of this entity's specialities (e.g., for food and dining: `Chicago style`) All strings must be non-empty when trimmed of whitespace. Array must be ordered. Array may have a maximum of 100 elements. Array item description: >Cannot Include: >* HTML markup Filtering Type: `list of text` ``` Eligible For: * financialProfessional * location * restaurant ``` uniqueItems: true type: array items: minLength: 0 maxLength: 100 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` tableService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a sit-down restaurant. Filtering Type: `option` ``` Eligible For: * hotel ``` takeoutHours: additionalProperties: false type: object properties: friday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Friday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Friday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' holidayHours: description: |- **NOTE:** The list of Holiday Hours that you send us must be comprehensive. For example, if you send us a list of Holiday Hours that does not include Holiday Hours that you sent in your last update, Yext considers the missing Holiday Hours to be deleted, and we remove them. Array must be ordered. Filtering Type: `list of object` uniqueItems: true type: array items: required: - date additionalProperties: false type: object properties: date: format: date type: string description: |- Date on which the holiday hours will be in effect. Cannot be in the past. Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on on the given date. Filtering Type: `boolean` isRegularHours: type: boolean description: |- Indicates whether the holiday hours are the same as the regular business hours for the given date. If set to true, we will update the holiday hours if the regular business hours change for the date's day of the week. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on the specified date. Filtering Type: `list of object` description: 'Filtering Type: `object`' monday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Monday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Monday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' reopenDate: format: date type: string description: |- Date must be on or after 1970-01-01 Date must be before or on 2038-01-01 Filtering Type: `date` saturday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Saturday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Saturday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' sunday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Sunday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Sunday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' thursday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Thursday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Thursday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' tuesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Tuesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Tuesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' wednesday: additionalProperties: false type: object properties: isClosed: type: boolean description: |- Indicates if the takeout hours are "closed" on Wednesday. Filtering Type: `boolean` openIntervals: uniqueItems: false type: array items: required: - start - end additionalProperties: false type: object properties: end: format: time type: string description: |- The end time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` start: format: time type: string description: |- The start time of the interval in `hh:mm` format (e.g., `"06:30"`, `"17:00"`). Filtering Type: `time` description: 'Filtering Type: `object`' description: |- Contains the time intervals for which the Entity is open for takeout on Wednesday. Note that if isClosed is set to true, "openIntervals" cannot be provided in an update. Filtering Type: `list of object` description: 'Filtering Type: `object`' description: |- Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of `takeoutHours`. (e.g. `monday`, `tuesday`, etc.) Open times can be specified per day through the `openIntervals` field and the `isClosed` flag. Similarly, holiday takeout hours are represented by the `holidayHours` sub-field. Setting the `reopenDate` sub-field indicates that the business is temporarily closed and will reopen on the specified date. SPECIAL CASES: * To indicate that an Entity is open 24 hours on a specific day, set start to 00:00 and end to 23:59 in `openIntervals` for that day. * To indicate that an Entity has split hours on a specific day (e.g., open from 9:00 AM to 12:00 PM and again from 1:00 PM to 5:00 PM), supply two or more `openIntervals` values with non-overlapping sets of hours. * If you are providing `openIntervals`, you may not set `isClosed` to true for that day. Filtering Type: `hours` ``` Eligible For: * location * restaurant ``` tennis: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has tennis courts. Filtering Type: `option` ``` Eligible For: * hotel ``` thermalPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a thermal pool. Filtering Type: `option` ``` Eligible For: * hotel ``` ticketAvailability: enum: - IN_STOCK - SOLD_OUT - PRE_ORDER - UNSPECIFIED type: string description: |- Information about the availability of tickets for the event Filtering Type: `option` ``` Eligible For: * event ``` ticketPriceRange: additionalProperties: false type: object properties: currencyCode: minLength: 0 type: string description: |- Three letter currency code (ISO standard) Filtering Type: `text` maxValue: pattern: ^\d*\.?\d*$ type: string description: |- Maximum ticket price Filtering Type: `decimal` minValue: pattern: ^\d*\.?\d*$ type: string description: |- Minimum ticket price Filtering Type: `decimal` description: |- Contains the price range for the event Filtering Type: `object` ``` Eligible For: * event ``` ticketSaleDateTime: format: date-time type: string description: |- The date/time tickets are available for sale (local time) Filtering Type: `datetime` ``` Eligible For: * event ``` ticketUrl: minLength: 0 format: uri type: string description: |- URL to purchase tickets for the event (if ticketed) Filtering Type: `text` ``` Eligible For: * event ``` tikTokUrl: minLength: 0 format: uri type: string description: |- URL for your TikTok profile, format should be https://www.tiktok.com/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` time: additionalProperties: false type: object properties: end: format: date-time type: string description: |- End date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` start: format: date-time type: string description: |- Start date/time of the event, in local time (see timezone field) Standard ISO 8601 datetime without timezone Format: `YYYY-MM-DDThh:mm` Filtering Type: `datetime` description: |- Contains the start/end times for the event Filtering Type: `object` ``` Eligible For: * event ``` timeZoneUtcOffset: minLength: 0 type: string description: |- Represents the time zone offset of the entity from UTC, in `±hh:mm` format. For example, if the entity is 4 hours ahead of UTC time, the offset will be `+04:00`. If the entity is 15.5 hours behind UTC time, the offset will be `-15:30`. If the entity is in UTC time, the offset will be `+00:00`. ``` Eligible For: * atm * event * faq * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` timezone: minLength: 0 type: string description: |- The timezone of the entity, in the standard `IANA time zone database` format (tz database). e.g. `"America/New_York"` Filtering Type: `option` ``` Eligible For: * atm * board * card * contactCard * event * faq * financialProfessional * healthcareFacility * healthcareProfessional * helpArticle * hotel * hotelRoomType * job * location * organization * product * restaurant ``` tollFreePhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` treadmill: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a treadmill. Filtering Type: `option` ``` Eligible For: * hotel ``` ttyPhone: minLength: 0 type: string description: |- Must be a valid phone number. If the phone number's calling code is for a country other than the one given in the entity's **`countryCode`**, the phone number provided must contain the calling code (e.g., `+44` in `+442038083831`). Otherwise, the calling code is optional. Filtering Type: `text` ``` Eligible For: * atm * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` turndownService: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers turndown service. Filtering Type: `option` ``` Eligible For: * hotel ``` twitterHandle: minLength: 0 maxLength: 15 type: string description: |- Valid Twitter handle for the entity without the leading "@" (e.g., `JohnSmith`) If you submit an invalid Twitter handle, it will be ignored. The success response will contain a warning message explaining why your Twitter handle wasn't stored in the system. Filtering Type: `text` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` uberLink: required: - presentation additionalProperties: false type: object properties: presentation: enum: - BUTTON - LINK type: string description: |- Indicates whether the embedded Uber link for this entity appears as text or a button When consumers click on this link on a mobile device, the Uber app (if installed) will open with your entity set as the trip destination. If the Uber app is not installed, the consumer will be prompted to download it. Filtering Type: `option` text: minLength: 0 maxLength: 100 type: string description: |- The text of the embedded Uber link Default is `Ride there with Uber`. **NOTE:** This field is only available if **`uberLink.presentation`** is `LINK`. Filtering Type: `text` description: |- Information about the Yext-powered link that can be copied and pasted into the markup of Yext Pages where the embedded Uber link should appear Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` uberTripBranding: required: - text - url - description additionalProperties: false type: object properties: description: minLength: 0 maxLength: 150 type: string description: |- A longer description that will appear near the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.description`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.url`**. Filtering Type: `text` text: minLength: 0 maxLength: 28 type: string description: |- The text of the call-to-action that will appear in the Uber app during a trip to your entity (e.g., `Check out our menu!`) **NOTE:** If a value for **`uberTripBranding.text`** is provided, values must also be provided for **`uberTripBranding.url`** and **`uberTripBranding.description`**. Filtering Type: `text` url: minLength: 0 format: uri type: string description: |- The URL that the consumer will be redirected to when tapping on the call-to-action in the Uber app during a trip to your entity. **NOTE:** If a value for **`uberTripBranding.url`** is provided, values must also be provided for **`uberTripBranding.text`** and **`uberTripBranding.description`**. Filtering Type: `text` description: |- Information about the call-to-action consumers will see in the Uber app during a trip to your entity Filtering Type: `object` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` valetParking: enum: - VALET_PARKING_AVAILABLE - VALET_PARKING_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers valet parking services. Filtering Type: `option` ``` Eligible For: * hotel ``` validThrough: format: date-time type: string description: |- The date this entity is valid through. Filtering Type: `datetime` ``` Eligible For: * job ``` vendingMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a vending machine. Filtering Type: `option` ``` Eligible For: * hotel ``` venueName: minLength: 0 type: string description: |- Name of the venue where the event is being held Filtering Type: `text` ``` Eligible For: * event ``` videos: description: |- Valid YouTube URLs for embedding a video on some publisher sites **NOTE:** Currently, only the first URL in the Array appears in your listings. Array must be ordered. Filtering Type: `list of object` ``` Eligible For: * financialProfessional * healthcareFacility * healthcareProfessional * hotel * hotelRoomType * location * organization * product * restaurant ``` uniqueItems: true type: array items: required: - video additionalProperties: false type: object properties: description: minLength: 0 maxLength: 140 type: string description: |- Cannot Include: * HTML markup Filtering Type: `text` video: required: - url additionalProperties: false type: object properties: url: minLength: 0 format: uri type: string description: 'Filtering Type: `text`' description: 'Filtering Type: `object`' description: 'Filtering Type: `object`' wadingPool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wading pool. Filtering Type: `option` ``` Eligible For: * hotel ``` wakeUpCalls: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers wake up call services. Filtering Type: `option` ``` Eligible For: * hotel ``` walkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as provided by you Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` waterPark: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water park. Filtering Type: `option` ``` Eligible For: * hotel ``` waterSkiing: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers water skiing. Filtering Type: `option` ``` Eligible For: * hotel ``` watercraft: enum: - WATERCRAFT_RENTALS - WATERCRAFT_RENTALS_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity offers any kind of watercrafts. Filtering Type: `option` ``` Eligible For: * hotel ``` waterslide: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a water slide. Filtering Type: `option` ``` Eligible For: * hotel ``` wavePool: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a wave pool. Filtering Type: `option` ``` Eligible For: * hotel ``` websiteUrl: additionalProperties: false type: object properties: displayUrl: minLength: 0 maxLength: 2000 format: uri type: string description: |- The URL that is shown on your listings in place of **`websiteUrl.url`**. You can use **`websiteUrl.displayUrl`** to display a short, memorable web address that redirects consumers to the URL given in **`websiteUrl.url`**. Must be a valid URL and be specified along with **`websiteUrl.url`**. Filtering Type: `text` preferDisplayUrl: type: boolean description: |- If set to true, only the display URL will be sent to those publishers who do not support separate display and tracking URLs for this field. Filtering Type: `boolean` url: minLength: 0 maxLength: 2000 format: uri type: string description: |- A valid URL for this entity's website Filtering Type: `text` description: |- Information about the website for this entity Filtering Type: `object` ``` Eligible For: * atm * contactCard * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` weightMachine: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates whether the entity has a weight machine. Filtering Type: `option` ``` Eligible For: * hotel ``` wheelchairAccessible: enum: - 'YES' - 'NO' - NOT_APPLICABLE type: string description: |- Indicates if the entity is wheelchair accessible. Filtering Type: `option` ``` Eligible For: * hotel ``` wifiAvailable: enum: - WIFI_AVAILABLE - WIFI_AVAILABLE_FOR_FREE - NOT_APPLICABLE type: string description: |- Indicates whether the entity has WiFi available Filtering Type: `option` ``` Eligible For: * hotel ``` workRemote: type: boolean description: |- Indicates whether the job is remote. Filtering Type: `boolean` ``` Eligible For: * job ``` yearEstablished: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The year the entity was established. Filtering Type: `integer` ``` Eligible For: * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yearLastRenovated: multipleOf: 1 minimum: 1000 maximum: 2028 type: number description: |- The most recent year the entity was partially or completely renovated. Filtering Type: `integer` ``` Eligible For: * hotel ``` yextDisplayCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates where the map pin for the entity should be displayed, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * job * location * restaurant ``` yextDropoffCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be dropped off at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextPickupCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Coordinates of where consumers can be picked up at the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextRoutableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for driving directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` yextWalkableCoordinate: additionalProperties: false type: object properties: latitude: minimum: -90 maximum: 90 type: number description: 'Filtering Type: `float`' longitude: minimum: -180 maximum: 180 type: number description: 'Filtering Type: `float`' description: |- Destination coordinates to use for walking directions to the entity, as calculated by Yext Filtering Type: `object` ``` Eligible For: * atm * event * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * restaurant ``` youTubeChannelUrl: minLength: 0 format: uri type: string description: |- URL for your YouTube channel, format should be https://www.youtube.com/c/yourUsername Filtering Type: `text` ``` Eligible For: * contactCard * financialProfessional * healthcareFacility * healthcareProfessional * hotel * location * organization * restaurant ``` 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' 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 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. For now, the only valid value here will be: * employee type: string 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 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' 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 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' 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 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 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' 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' 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' Resource: type: object description: | A JSON representation of the resource. Please refer to the [Hitchhiker's guide](https://hitchhikers.yext.com/docs/resources/) for the exact resource schema. UpdateLicenseAssignmentRequestBody: type: object properties: expirationDate: type: string description: The license will be unassigned at the beginning of the day on this date. LicensePack: type: object description: License pack details. properties: id: type: string description: The external ID of this license pack. name: type: string description: The name of this license pack. total: type: integer description: The total number of licenses on this license pack. assigned: type: integer description: The number of assigned licenses on this license pack. available: type: integer description: The number of available licenses on this license pack. notes: type: string description: The notes on this license pack. AssignedEntity: type: object properties: entityId: type: string description: The external entity ID of the entity. expirationDate: type: string description: The expiration date of the license assignment. LicenseAssignment: type: object properties: licensePack: $ref: '#/components/schemas/LicensePack' assignedEntities: type: array description: A list of assigned entities. items: $ref: '#/components/schemas/AssignedEntity' LicensePacks: type: object properties: licensePacks: type: array items: $ref: '#/components/schemas/LicensePack' nextPageToken: $ref: '#/components/schemas/NextPageToken' LicenseAssignments: type: object properties: licenseAssignments: type: array items: $ref: '#/components/schemas/LicenseAssignment' nextPageToken: $ref: '#/components/schemas/NextPageToken' FieldBehavior: type: string description: | Defines the field editing mode for a blank field or for a field which has content. If `USE_AUTOMATIC_COMPUTATIONS_BEHAVIOR` is chosen, the behavior will match that of the behavior set for automated computations, if enabled. example: WRITE_DIRECTLY enum: - SKIP - USE_AUTOMATIC_COMPUTATIONS_BEHAVIOR - CREATE_SUGGESTION - WRITE_DIRECTLY TargetFields: properties: targetFields: type: object description: | The collection of fields to compute a value for. For requests either IDs or UIDs must be provided, but not both. Responses will always return both. properties: ids: type: array description: The external IDs of the fields. items: type: string example: c_blogPost uids: type: array description: The internal IDs of the fields. items: type: string example: location.custom.123456.blogpost.0 TriggerFields: properties: triggerFields: type: object description: | The list of updated fields that may be a trigger for a field computation. For requests either IDs or UIDs must be provided, but not both. Responses will always return both. properties: ids: type: array description: The external IDs of the fields. items: type: string example: c_blogPost uids: type: array description: The internal IDs of the fields. items: type: string example: location.custom.123456.blogpost.0 EntityScope: oneOf: - $ref: '#/components/schemas/TargetFields' - $ref: '#/components/schemas/TriggerFields' allOf: - type: object properties: blankFieldBehavior: $ref: '#/components/schemas/FieldBehavior' populatedFieldBehavior: $ref: '#/components/schemas/FieldBehavior' entityScope: type: object description: | The set of entities and locales to trigger a computation for. The final set of entity profiles is the set of valid entity profiles generated from the union of IDs and locales. **NOTE**: An empty or unset locales field will default to the primary locale of the entity. properties: locales: type: array items: type: string example: en description: The list of locales to compute a computation for. entityIds: type: object description: | For requests either IDs or UIDs must be provided, but not both. Responses will always return both. properties: ids: type: array items: type: string example: customEntity description: The external IDs of the entities. uids: type: array items: type: integer example: 1234 description: The internal IDs of the entities. EntityProfileScope: oneOf: - $ref: '#/components/schemas/TargetFields' - $ref: '#/components/schemas/TriggerFields' allOf: - type: object properties: blankFieldBehavior: $ref: '#/components/schemas/FieldBehavior' populatedFieldBehavior: $ref: '#/components/schemas/FieldBehavior' entityProfileScope: type: object description: The exact entity profiles to trigger a computation for. properties: entityProfileIds: type: array description: | For requests either IDs or UIDs must be provided, but not both. Responses will always return both. **NOTE**: An unset locale field will default to the primary locale of the entity. items: type: object properties: id: type: string example: customEntity uid: type: integer example: 123456 locale: type: string example: en SavedFilterScope: oneOf: - $ref: '#/components/schemas/TargetFields' - $ref: '#/components/schemas/TriggerFields' allOf: - type: object properties: blankFieldBehavior: $ref: '#/components/schemas/FieldBehavior' populatedFieldBehavior: $ref: '#/components/schemas/FieldBehavior' savedFilterScope: type: object description: | The set of entities that match a given set of saved filters. **NOTE**: An empty or unset locales field will default to the primary locale of the entity. properties: locales: type: array items: type: string example: en description: The list of locales to compute a computation for. savedFilterIds: type: object description: | For requests either IDs or UIDs must be provided, but not both. Responses will always return both. properties: ids: type: array items: type: string example: 1268765 description: The external IDs of the saved filters. uids: type: array items: type: integer example: 235 description: The internal IDs of the saved filters. EntityTypeScope: oneOf: - $ref: '#/components/schemas/TargetFields' - $ref: '#/components/schemas/TriggerFields' allOf: - type: object properties: blankFieldBehavior: $ref: '#/components/schemas/FieldBehavior' populatedFieldBehavior: $ref: '#/components/schemas/FieldBehavior' entityTypeScope: type: object description: | The set of entity types and locales to trigger a computation for. The final set of entity profiles is the set of valid entity profiles generated from the union of Entity Types and locales. **NOTE**: An empty or unset locales field will default to the primary locale of the entity. properties: locales: type: array items: type: string example: en description: The list of locales to compute a computation for. entityTypeIds: type: object description: | For requests either IDs or UIDs must be provided, but not both. Responses will always return both. properties: ids: type: array items: type: string example: blogPost description: The external IDs of the entity types. uids: type: array items: type: integer example: 1234 description: The internal IDs of the entity types. EntityProfileSearchScope: oneOf: - $ref: '#/components/schemas/TargetFields' - $ref: '#/components/schemas/TriggerFields' allOf: - type: object properties: blankFieldBehavior: $ref: '#/components/schemas/FieldBehavior' populatedFieldBehavior: $ref: '#/components/schemas/FieldBehavior' searchScope: type: object description: | The set of entities that match a given filter. The filter itself is redacted on read. **NOTE**: Search Scope operations cannot be created using the API An empty or unset locales field will default to the primary locale of the entity. properties: locales: type: array items: type: string example: en description: The list of locales to compute a computation for. scopeRedacted: type: boolean example: true OperationDefinitionResponseOptions: oneOf: - $ref: '#/components/schemas/EntityScope' - $ref: '#/components/schemas/EntityProfileScope' - $ref: '#/components/schemas/SavedFilterScope' - $ref: '#/components/schemas/EntityTypeScope' - $ref: '#/components/schemas/EntityProfileSearchScope' Operation: type: object properties: name: type: string description: | The resource name. Format: accounts/{account}/computations/{system-generated-id} example: accounts/553564/computations/01HEV7A955WFEXNWDKRDRC5VM3 uid: type: string description: The system generated ID. example: 01HEV7A955WFEXNWDKRDRC5VM3 accountId: type: string description: The ID of the business owning the operation. example: 553564 createTime: type: string description: Timestamp of when the operation was created. example: '2023-11-09T23:40:12.325Z' startTime: type: string description: Timestamp of when the operation was started. example: '2023-11-09T23:40:12.325Z' completeTime: type: string description: Timestamp of when the operation was completed. example: '2023-11-09T23:40:12.325Z' definition: allOf: - $ref: '#/components/schemas/OperationDefinitionResponseOptions' - type: object properties: triggerType: type: string description: | Determines if a computation was triggered manually or if it was automatically triggered by some other field/fields. enum: - MANUAL - AUTOMATIC description: The definition of the computation operation. languageCode: type: string description: | Language code to be used to localize messages. If no language code was provided, it will default to English. example: en resultMetadata: type: object properties: updatedEntityProfileCount: type: integer description: Count of unique entity profiles updated. example: 0 updatedFieldCount: type: integer description: | Count of unique fields updated. This is number of entity-profiles*fields-per-entity. example: 0 upsertedSuggestionsCount: type: integer description: | Count of suggestions upserted. Suggestions are per entity-field. example: 0 updatedErrorCount: type: integer description: Count of errors encountered while updating entities. example: 0 suggestionsErrorCount: type: integer description: Count of errors encountered while generating suggestions. example: 0 generationErrors: type: integer description: Count of errors in generating a value. example: 0 status: type: string enum: - CREATED - PROCESSING - COMPLETED - COMPLETED_WITH_ERRORS - FAILED - CANCELED description: The current status of the operation. example: PROCESSING updateTime: type: string description: | Timestamp of when the operation result was was last updated. example: '2023-11-09T23:40:17.065208732Z' requestMetadata: type: object properties: entityProfileRequestCount: type: integer description: Count of unique entity profiles that need to be processed. example: 1 entityFieldRequestCount: type: integer description: | Count of unique entity-profile-fields that need to be computed. example: 1 planningCompleted: type: boolean description: | Boolean indicating whether or not planning has been fully completed. example: true OperationDefinitionOptions: oneOf: - $ref: '#/components/schemas/EntityScope' - $ref: '#/components/schemas/EntityProfileScope' - $ref: '#/components/schemas/SavedFilterScope' - $ref: '#/components/schemas/EntityTypeScope' CreateOperationRequest: type: object required: - definition properties: definition: $ref: '#/components/schemas/OperationDefinitionOptions' languageCode: type: string description: | Language code to be used to localize messages. If no language code is specified, it will default to English. example: en details: type: object description: | An arbitrary object that can hold any additional metadata provided by the caller. properties: source: type: string example: API Test nextPageToken: type: string description: The token to use to retrieve the next page of results. If empty, this is the last page. example: eyJ0b2tlbiI6InB4Zl9wYWdlX3Rva2VuIn0= previousPageToken: type: string description: The token to use to retrieve the previous page of results. If empty, this is the first page. example: eyJ0b2tlbiI6InB4Zl9wcmV2X3BhZ2VfdG9rZW4ifQ== totalSize: type: integer description: The total number of items that match the filter criteria, ignoring pagination. example: 100 certificate_authority: type: string enum: - GOOGLE_TRUST - LETS_ENCRYPT default: GOOGLE_TRUST managed_csr: description: | SSL certificate will be issued using the given [Managed CSR](#tag/Domains/operation/createManagedCsr). Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object properties: managed_csr_id: description: | The name of the [Managed CSR](#tag/Domains/operation/createManagedCsr) resource. type: string example: accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 custom_public_certificate: description: | Public CA signed certificate. type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid custom_ssl_certificate: description: | The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of `managed_ssl`, `managed_csr`, or `custom_ssl_certificate` must be set for a domain. type: object required: - public_certificate - private_key properties: public_certificate: type: string format: pem writeOnly: true example: | -----BEGIN CERTIFICATE----- MIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh ... -----END CERTIFICATE----- private_key: type: string format: pem writeOnly: true example: | -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG ... -----END PRIVATE KEY----- hostname_validation: description: | Proof of ownership for the SSL provider. type: object readOnly: true properties: cname_target: type: string example: idzm5s34j5.yext.pgscdncf.com. txt_domain: type: string example: _yext-domain.www.example.com txt_value: type: string format: uuid http_uri: type: string example: http://www.example.com/.well-known/yext-domain-challenge/35f00e6a-61c2-4857-b2cc-4c736f86b5ac http_body: type: string format: uuid site: description: The Pages site to associate with the parent [Domain](#tag/Domains/operation/createDomain) resource. type: object properties: name: description: Pages site resource name. type: string example: accounts/123456/sites/6789 primary: description: | If true, this will be the primary Domain for the Pages site, otherwise it will be an alias Domain. A Pages site can have at most one primary Domain. type: boolean default: false parameters: accountId: name: accountId in: path required: true schema: type: string v: name: v in: query required: true schema: type: string description: A date in `YYYYMMDD` format. limit: name: limit in: query schema: type: integer default: 10 maximum: 50 description: Number of results to return. offset: name: offset in: query required: false schema: type: integer default: 0 description: | Number of results to skip. Used to page through results. Cannot be used together with **`pageToken`**. 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" 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. 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. filters: name: filters in: query required: false schema: type: string description: | A set of filters that is applied to the set of locations that would otherwise be returned. Should be provided as a URL-encoded string containing a JSON array. The array should have one or more filter objects defined. All filter objects will apply as an intersection (i.e., AND). Field names reference Location fields, as well as custom fields using the format `custom###`, where "###" is the custom field’s **`id`**. For example, to provide a filter that would match location names containing the word "gourmet", the filter parameter would be `[{"name":{"contains":["gourmet"]}}]`, which URL-encoded would be `%5B%7B%22name%22%3A%7B%22contains%22%3A%5B%22gourmet%22%5D%7D%7D%5D`. NOTE: "x", "xx", and "xxx" are reserved keywords that, when passed in a `contains` matcher for a Full or Text filter, will cause that filter to match on all locations. The filter types are the following. Note there may be multiple available specifications for a given filter type:
Filter Type Syntax Description
Full fieldName: {contains: $search} $search is the search string
Text fieldName: {$type: [$search,...]} $type is one of [contains,doesNotContain,startsWith,equalTo], $search is an array of search strings, combined with OR
Text fieldName: $type $type is one of [empty,notEmpty]
Number fieldName: {$type: $value} $type is one of [eq,lt,gt,le,ge], $value is the numeric value
Number fieldName: {$type: [$value1, $value2]} $type is one of [between], $value1 and $value2 are numeric values
Date fieldName: {$type: $value} $type is one of [eq,lt,gt,le,ge], $value is a string of "YYYY-MM-DD" formatted date
Date fieldName: $type $type is one of [empty,notEmpty]
Date fieldName: {$type: [$value1, $value2]} $type is one of [between], $value1 and $value2 are strings of "YYYY-MM-DD" formatted date
Categories fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
Categories fieldName: $type $type is one of [none]
Assets fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of numeric category IDs, combined with OR
Assets fieldName: $type $type is one of [none]
Country fieldName: {$type: [$country,...]} $type is one of [includes,notIncludes], $country is an array of country code strings, combined with OR
PrimaryLanguage fieldName: {$type: [$language,...]} $type is one of [is,isNot], $language is an array of language code strings, combined with OR
AlternateLanguage fieldName: {$type: [$language,...]} $type is one of [includes, notIncludes], $language is an array of language code strings, combined with OR
StringSingle fieldName: {$type: [$string,...]} $type is one of [is,isNot], $string is an array of strings, combined with OR
StringList fieldName: {$type: [$string,...]} $type is one of [includes,notIncludes], $string is an array of strings, combined with OR
LocationType fieldName: {$type: [$id,...]} $type is one of [is,isNot], $id is an array of location type IDs, combined with OR
Bool fieldName: $type $type is one of [true,false]
Option fieldName: {$type: $id} $type is one of [is,isNot], $id is an option ID (For single option custom fields)
Option fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of option IDs, combined with OR (For multi option custom fields)
Folder fieldName: [$id,...] $id is a numeric folder ID
Folder fieldName: $id $id is a numeric folder ID
Folder fieldName: {$type: [$id,...]} $id is a numeric folder ID, $type is one of ['isIn', 'isNotIn']
Labels fieldName: {$type: [$id,...]} $type is one of [includes,notIncludes], $id is an array of label IDs, combined with OR
The following fields can be specified in the request (Field name/Filter Type/Example(s)):
Field Name Filter Type Example(s)
location Full "location": {"contains": "Atlanta"}
name Text "name": {"startsWith": ["Guitar"]}, "name": {"contains": ["A","B"]}
address Text "address": {"startsWith": ["South"]}
address2 Text "address2": {"contains": ["Suite"]}
city Text "city": {"contains": ["Atlanta"]}
state Text "state": {"contains": ["AK","VA"]}
zip Text "zip": {"contains": ["M5K 7QB"]}
phones Text "phones": {"startsWith": ["703","571"]}
specialOffer Text "specialOffer": "notEmpty"
emails Text "emails": {"doesNotContain": ["@yext.com"]}
website Text "website": {"equalTo": ["https://www.yext.com/"]}
categories Categories "categories": {"includes": [23,755,34]}
closed Bool "closed": true
storeId Text "storeId": {"equalTo": ["MCD0001"]}
countryCode Country "countryCode": {"notIncludes": ["US"]}
products Text "products": {"startsWith": ["Burger","Fries"]}
services Text "services": {"contains": ["Manicures"]}
specialities Text "services": "notEmpty"
associations Text "associations": "empty"
brands Text "brands": {"equalTo": ["North Face"]}
languages Text "languages": {"equalTo": ["English","Spanish"]}
keywords Text "keywords": {"startsWith": ["Franchise"]}
menuIds IdList "menuIds": {"includes": ["m-23","755","menu34"]}
productListIds IdList "productListIds": {"notIncludes": ["pl-2"]}
calendarIds IdList "calendarIds": {"notIncludes": ["cal34"]}
bioIds IdList "bioIds": {"includes": ["b23","34"]}
custom### Text (for Multiline Text, URL, Text List, and Text Custom Fields), Number, Date, Bool, or Option "custom123": {"equalTo": ["asdf"]}
folder Folder "folder": 123, "folder": [123,456]
primary_language PrimaryLanguage "primary_language": {"is": "fr_CA"}
alternateProfileLanguage AlternateLanguage "alternateProfileLanguage": {"includes": ["en", "fr"]}
npi StringSingle "npi": {"is": ["1234567890", "1111111111"]}
conditionsTreated Text "conditionsTreated": {"startsWith": ["Influenza"]}, "conditionsTreated": {"contains": ["A","B"]}
lastUpdated Date "lastUpdated": {"eq": "2018-01-01"}, "lastUpdated": {"between": ["2017-01-01", "2018-01-01"]}
fieldsWithData Fields "fieldsWithData": ["email", "hours"]
fieldsWithoutData Fields "fieldsWithoutData": ["logo", "video"]
reviewCount Number "review_count": {"gt": 1}, "review_count ": {"lt": 10}
averageRating Number "averageRating": {"lt": 3}
locationType LocationType "locationType": {"is": [1]}, "locationType": {"isNot": [123]}
gender StringSingle "gender": {"is": ["FEMALE"]}, "gender": {"isNot": ["MALE"]}
degrees StringList "degrees": {"includes": ["MD"]}, "degrees": {"notIncludes": ["PHD"]}
experiences StringList "experiences": {"includes": ["FELLOWSHIP"]}, "experiences": {"notIncludes":["INTERNSHIP"]}
yearCompleted Number "yearCompleted": {"gt": 2000}, "yearCompleted": {"lt": 2015}
acceptingNewPatients Bool "acceptingNewPatients": true
firstName Text "firstName": {"startsWith": ["David"]}, "firstName": {"contains": ["A","B"]}
middleName Text "middleName": {"startsWith": ["P"]}, "middleName": {"contains": ["N","E"]}
lastName Text "lastName": {"startsWith": ["Sm"]}, "lastName": {"contains": ["Y","Z"]}
officeName Text "officeName": {"startsWith": ["Chiropractic"]}, "officeName": {"contains":["Center","P"]}
certifications Text "certifications": {"contains": ["Radiation Oncology"]}
institutionName Text "institutionName": {"startsWith": ["New York"]}
insuranceAccepted Text "insuranceAccepted": {"startsWith": ["United"]}, "insuranceAccepted":{"contains": ["C","Health"]}
admittingHospitals Text "admittingHospitals": {"startsWith": ["Children's"]}, "admittingHospitals":{"contains": ["Medical","University"]}
subscriptions IdList "subscriptions": {"notIncludes": ["123"]}
facebookAccounts IdList "facebookAccounts": {"notIncludes": ["1111"]}
foursquareAccounts IdList "foursquareAccounts": {"notIncludes": ["1111"]}
googleplusAccounts IdList "googleplusAccounts": {"notIncludes": ["1111"]}
labels Labels "labels": {"includes": [1, 100]}
locationId: name: locationId in: path required: true schema: type: string listId: name: listId in: path required: true schema: type: string description: ID of this List. 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. 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. 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. 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. language_code: name: language_code in: path schema: type: string required: true description: Locale code. publisherSiteId: name: publisherSiteId in: path required: true schema: type: string description: Publisher site ID. listingsLocationIds: name: locationIds in: query schema: type: array items: type: string description: | Defaults to all account locations with a Listings subscription. **Example:** loc123,loc456,loc789 style: simple listingsPublisherIds: name: publisherIds in: query schema: type: array items: type: string description: | List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. **Example:** MAPQUEST,FACEBOOK style: simple listingsLocationId: name: locationId in: query schema: type: string description: An account location ID with a Listings subscription. listingsPublisherIdQuery: name: publisherId in: query schema: type: string required: true listingsPublisherId: name: publisherId in: path schema: type: string required: true locale: name: locale in: path schema: type: string required: true description: Locale code. listingsVerficationEntityIds: name: entityIds in: query schema: type: string required: false description: | A comma-separated list of Entity IDs. If no IDs are specified, defaults to all entities with a listings subscription. verificationLimit: name: limit in: query schema: type: integer default: 100 description: Number of results to return. listingsEntityIds: name: entityIds in: query schema: type: array items: type: string description: | Defaults to all account events with a subscription. **Example:** entity123,entity456,entity789 style: simple listingsEventPublisherIds: name: publisherIds in: query schema: type: array items: type: string description: | List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. **Example:** FACEBOOKEVENTS,EVENTBRITE style: simple QuestionAnswerFilter: name: filter required: false schema: type: string in: query description: | This parameter represents one or more filtering conditions that are applied to the set of entities that would otherwise be returned. This parameter should be provided as a URL-encoded string containing a JSON object. For example, if the filter JSON is `{"entityId":{"$eq":"location123"}}`, then the filter param after URL-encoding will be: `filter=%7B%22entityId%22%3A%7B%22%24eq%22%3A%22location123%22%7D%7D` **Supported filters** * **`id`** * **`entityId`** * **`publisherId`** * **`authorType`** * **`language`** * **`createTime`** * **`updateTime`** * **`answerCount`** * **`ownerAnswer`** **Basic Filter Structure** The filter object at its core consists of a *matcher*, a *field*, and an *argument*. For example, in the following filter JSON: ``` { "entityId":{ "$eq":"location123" } } ``` `$eq` is the *matcher*, or filtering operation (equals, in this example), `entityId` is the *field* being filtered by, and `location123` is *value* to be matched against. **Combining Multiple Filters** Multiple filters can be combined into one object using *combinators*. For example, the following filter JSON combines multiple filters using the combinator `$and`. `$or` is also supported. ``` { "$and":[ { "entityId":{ "$eq":"location123" } }, { "authorType":{ "$in":[ "LOCAL_GUIDE", "MERCHANT" ] } } ] } ``` **Filter Negation** Certain filter types may be negated. For example: ``` { "$not": { "entityId": { "$eq": "location123" } } } ``` This can also be written more simply with a `!` in the `$eq` parameter. The following filter would have the same effect: ``` { "entityId":{ "!$eq":"location123" } } ``` **TEXT** The `TEXT` filter type is supported for text fields. (e.g., **`entityId`**, **`authorType`**)
Matcher Details
$eq (equals) { "entityId":{ "$eq":"location123" } }, { "authorType":{ "!$eq":"REGULAR_USER" } } Supports negation. Case insensitive.
**BOOLEAN** The BOOLEAN filter type is supported for boolean fields and Yes / No fields.
Matcher Details
$eq { "ownerAnswer": { "$eq": true } } For booleans, the filter takes a boolean value, not a string. Supports negation.
**INTEGER, FLOAT, DATE, DATETIME, and TIME** These filter types are strictly ordered -- therefore, they support the following matchers: - Equals - Less Than / Less Than or Equal To - Greater Than / Greater Than or Equal To
Matcher Details
$eq Equals { "answerCount": { "$eq": 3 } } Supports negation.
$lt Less than { "updateTime": { "$lt": 1579711121392 } }
$gt Greater than { "answerCount": { "$gt": 3 } }
$le Less than or equal to { "answerCount": { "$le": 3 } }
$ge Greater than or equal to { "answerCount": { "$ge": 3 } }
Combinations While we do not support "between" in our filtering syntax, it is possible to combine multiple matchers for a result similar to an "and" operation: { "answerCount : { "$gt" : 1, "$lt": 3 } }
questionId: name: questionId in: path required: true schema: type: integer description: ID of this Question. reviewId: name: reviewId in: path required: true schema: type: integer description: ID of this Review. commentId: name: commentId in: path required: true schema: type: string invitationId: name: invitationUid in: path required: true schema: type: string description: | The UID of this Review Invitation. This UID can be included as part of Review Creation requests for attribution. workflowRuleId: name: workflowRuleId in: path required: true schema: type: string description: ID of this Workflow Rule. entityPostId: name: entityPostId in: path required: true schema: type: string description: | The ID of an individual post created for a given entity on a given publisher. userId: name: userId in: path required: true schema: type: string approvalGroupId: name: approvalGroupId in: path required: true schema: type: string linkedAccountsEntityIds: name: entityIds in: query schema: type: array items: type: string required: false description: When provided, only linked accounts assigned to the specified entities will be returned. linkedAccountsPublisherIds: name: publisherIds in: query schema: type: array items: type: string required: false description: When provided, only linked accounts for the specified sites will be returned. linkedAccountsStatuses: name: statuses in: query schema: type: array items: type: string enum: - VALID - INVALID required: false description: Defaults to all statuses. When specified, only linked accounts with the provided statuses will be returned. linkedAccountId: name: linkedAccountId in: path required: true schema: type: string taskIds: name: taskIds in: query schema: type: string description: | Comma-separated list of Optimization Task IDs corresponding to Optimization Tasks that should be included in the response. If no IDs are provided, defaults to all available Optimization Tasks in the account. taskLocationIds: name: locationIds in: query schema: type: string description: | Comma-separated list of Location IDs to be used as a filter. If no IDs are provided, defaults to all Locations in the account. taskLocationId: name: locationId in: query schema: type: string description: | Location ID to be used as a filter. If no ID is provided, defaults to all Locations in the account. mode: name: mode in: query schema: type: string enum: - PENDING_ONLY - ALL_TASKS - RESET default: PENDING_ONLY description: | When mode is `PENDING_ONLY`, the resulting link will only ask the user to complete tasks that are pending or in progress (that have not been completed before). When mode is `ALL_TASKS`, the resulting link will show the user all specified tasks for all specified locations, regardless of their status. If a task has been completed, the user is given the option to update the content they entered when completing the task. assetId: name: assetId in: path required: true schema: type: string 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**." Valid values: * `markdown` * `html` * `none` required: false suggestionUid: name: suggestionUid in: path required: true schema: type: string description: The Yext-generated unique identifier for the Suggestion. resourceGroup: name: resourceGroup description: | Group of the resource For example, for `km/entity`, the resourceGroup is `km` in: path required: true schema: type: string resourceSubType: name: resourceSubType description: | Subtype of the resource For example, for `km/entity`, the resourceSubType is `entity` in: path required: true schema: type: string resourceId: name: resourceId description: $id (name) of the resource in: path required: true schema: type: string licensePackId: name: licensePackId description: License Pack ID found on the Account Settings / License Packs page. in: path required: true schema: type: string entityId: name: entityId in: path schema: type: string required: true description: | The external ID of the requested Entity. pageSize: name: pageSize description: Number of results to return. in: query schema: type: integer assignedEntity: name: assignedEntity description: | If you want to list all of the license packs assigned to a specific entity, you can provide the entity's external ID as a parameter. in: query schema: type: string computationOperationUid: name: operationUid in: path required: true schema: type: string description: The Yext-generated unique identifier for the computation operation. hostnameFilters: name: hostname in: query schema: type: array items: type: string description: Exact hostname(s) to filter results by. If not provided, results for all hostnames will be returned. example: www.example.com,test.example.com hostnameSearchFilter: name: hostname_search in: query schema: type: string description: Case-insensitive substring used to filter by hostname. example: example showDeleted: name: show_deleted in: query schema: type: boolean default: false index_pageSize: name: page_size in: query schema: type: integer default: 10 minimum: 0 maximum: 50 description: Number of results to return per page. Sizes above the maximum will be clamped at the maximum value. index_pageToken: name: page_token in: query schema: type: string description: Token to retrieve the next page of results. If not provided, the first page of results will be returned. viewDefaultBasic: name: view in: query schema: type: string enum: - FULL - BASIC default: BASIC description: | `FULL` returns all details, while `BASIC` omits certain SSL information. Using `BASIC` will also usually result in a lower response latency relative to using `FULL`. domainId: name: domainId in: path required: true schema: type: string format: uuid viewDefaultFull: name: view in: query schema: type: string enum: - FULL - BASIC default: FULL description: | `FULL` returns all details, while `BASIC` omits certain SSL information. Using `BASIC` will also usually result in a lower response latency relative to using `FULL`. forceMove: name: force_move in: query schema: type: boolean default: false description: If true, and the domain is in a MOVE_REQUIRED state, will move ownership of the domain to this account. domainIdAllowAll: name: domainId in: path required: true schema: type: string format: uuid description: Set to "-" to reference Domain Associations from all domains in this account. domainAssociationId: name: domainAssociationId in: path required: true schema: type: string format: uuid managedCsrId: name: managedCsrId in: path required: true schema: type: string format: uuid responses: ErrorResponse: description: Error Response content: application/json: schema: title: ErrorResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMetaWithError' response: type: object 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' 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 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' LocationResponse: description: Location Response. content: application/json: schema: title: LocationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' 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' 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' MenuResponse: description: Menu Response. content: application/json: schema: title: MenuListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Menu' EmptyResponse: description: Empty Response. content: application/json: schema: title: EmptyResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object 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' BioResponse: description: Bio List Response. content: application/json: schema: title: BioListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Bio' 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' ProductResponse: description: Product List Response. content: application/json: schema: title: ProductListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Product' 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' EventResponse: description: Event List Response. content: application/json: schema: title: EventListResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Event' 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' 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' 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' 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 CustomFieldResponse: description: Custom Field Response. content: application/json: schema: title: CustomFieldResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Field' 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' LanguageProfileResponse: description: Language Profile Response. content: application/json: schema: title: LanguageProfileResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Location' ListPublisherDisruptionsResponse: description: List Publisher Disruptions Response content: application/json: schema: title: ListPublisherDisruptionsResponse type: object properties: meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: description: | If there are more disruptions than the specified page size, pagination data will be included to retrieve the next page of data. type: object properties: pageToken: type: string description: | Token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. response: type: object properties: disruptions: type: array items: $ref: '#/components/schemas/PublisherDisruption' ListPublisherDisruptionStatusUpdatesResponse: description: List Publisher Disruption Status Updates Response content: application/json: schema: title: ListPublisherDisruptionStatusUpdatesResponse type: object properties: meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: description: | If there are more status updates than the specified page size, pagination data will be included to retrieve the next page of data. type: object properties: pageToken: type: string description: | Token that can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. response: type: object properties: statusUpdates: type: array items: $ref: '#/components/schemas/PublisherDisruptionStatusUpdate' ListPublishersResponse: description: Publishers Response content: application/json: schema: title: PublishersResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: publishers: type: array items: $ref: '#/components/schemas/Publisher' ListListingAccuracyResponse: description: Listings Accuracy Response content: application/json: schema: title: ListListingAccuracyResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: listingAccuracy: type: array items: $ref: '#/components/schemas/ListingAccuracy' ListListingsResponse: description: Listings Response content: application/json: schema: title: ListingsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: | If the **`v`** parameter is before `20170420`: the Listings count, including alternate brands If the **`v`** parameter is `20170420` or later: the Listings count, excluding alternate brands Total number of Listings that meet the filter criteria (ignores **`limit`** and **`offset`**) listings: type: array items: $ref: '#/components/schemas/Listing' pageToken: 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. **`pageToken`** is only returned with the inclusion of a **`v`** parameter of `20210915` or later when there is no **`offset`** in the query parameter. ConfirmSyncResponse: description: Confirm Sync Response content: application/json: schema: title: ConfirmSyncResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: pageToken: type: string description: | Token used for pagination to continue confirm sync in a subsequent request. **`pageToken`** is returned only when the **`v`** parameter is `20260401` or later. ListPublisherSuggestionsResponse: description: Publisher Suggestions Response content: application/json: schema: title: PublisherSuggestionsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Publisher Suggestions that meet filter criteria (ignores limit/offset) suggestions: type: array items: $ref: '#/components/schemas/PublisherSuggestion' PublisherSuggestionResponse: description: Publisher Suggestion Response content: application/json: schema: title: PublisherSuggestionResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/PublisherSuggestion' ListDuplicatesResponse: description: Duplicates Response content: application/json: schema: title: DuplicatesResponse 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) duplicates: type: array items: $ref: '#/components/schemas/Duplicate' ListMethodsResponse: description: Methods Response content: application/json: schema: title: ListMethodsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of verification methods that meet the filter criteria. verificationMethods: type: array items: $ref: '#/components/schemas/VerificationMethod' nextPageToken: $ref: '#/components/schemas/NextPageToken' ListStatusesResponse: description: Statuses Response content: application/json: schema: title: ListStatusesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of verification statuses that meet the filter criteria. verifications: type: array items: $ref: '#/components/schemas/VerificationStatus' nextPageToken: $ref: '#/components/schemas/NextPageToken' InitiateVerificationResponse: description: Initiate Verification Response content: application/json: schema: title: InitiateVerificationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of successful requests. entityIds: type: array description: IDs of entities that were successfully verified. items: type: string CompleteVerificationResponse: description: Complete Verification Response content: application/json: schema: title: CompleteVerificationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of successful requests. entityIds: type: array description: IDs of entities that were successfully verified. items: type: string ListAdminsResponse: description: List Admins Response content: application/json: schema: title: ListAdminsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of admins that meet the filter criteria. admins: type: array items: $ref: '#/components/schemas/Admin' nextPageToken: $ref: '#/components/schemas/NextPageToken' InviteAdminsResponse: description: Invite Admins Response content: application/json: schema: title: InviteAdminsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: | Total number of Admins created. admins: type: array items: $ref: '#/components/schemas/Admin' ListEntityListingsResponse: description: Entity Listings Response content: application/json: schema: title: EntityListingsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: | Total number of Listings that meet the filter criteria (ignores **`limit`** and **`offset`**) 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. listings: type: array items: $ref: '#/components/schemas/EntityListing' ListQuestionsResponse: description: List Questions Response content: application/json: schema: title: ListQuestionsReponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: | Total number of questions that meet the filter criteria (ignores **`limit`** and **`offset`**) pageToken: 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. questions: type: array items: $ref: '#/components/schemas/Question' QuestionResponse: description: Question Response content: application/json: schema: title: QuestionResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Question' CatalogResponse: description: Completed dates of all metrics available content: application/json: schema: title: CatalogResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: metrics: type: array items: $ref: '#/components/schemas/Metric' MaxDatesResponse: description: Maximum date through which reporting data is available content: application/json: schema: title: MaximumDatesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: standardMaxDate: type: string format: date description: The date through which reporting data is available from Listings publishers other than Bing. bingMaxDate: type: string format: date description: The date through which Bing data is available. CreateReportsResponse: description: Returns report data if synchronous or report id if asynchronous content: application/json: schema: title: CreateReportsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: data: type: array items: type: object additionalProperties: type: string description: Array with the contents of the report (encoded UTF-8), as specified in the request. This is returned for a synchronous request id: type: string description: the ID of the report. This is returned for an asynchronous request ReportStatusResponse: description: Status of a report created with async=true content: application/json: schema: title: ReportStatusResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: status: type: string enum: - PROCESSING - DONE - FAILED url: type: string description: When status=DONE, contains the URL to download the report data as a text file. GetTablesResponse: description: Returns tables that can be queried from the POST Query endpoint in the Logs API. content: application/json: schema: title: GetTablesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: logTables: type: array items: type: object properties: id: type: string description: Table Identifier description: Array with tables that can be queried from the POST Query endpoint in the Logs API. GetTableResponse: description: Returns schema for table returned from the GET Tables endpoint in the Logs API. content: application/json: schema: title: GetTableResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: string description: Table Name associated with schema fields: type: array items: type: object properties: id: type: string description: Identifier for field dataType: type: string description: Datatype of field CreateQueryResponse: description: Returns results of query. content: application/json: schema: title: createQueryResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: logRecords: type: array items: type: object additionalProperties: type: string description: Array with the query results. nextPageToken: type: string description: Token for paginating queries which return more records than the pageSize specified. ReviewsResponse: description: Reviews Response content: application/json: schema: title: ReviewsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Reviews that meet filter criteria (ignores limit/offset) averageRating: type: number format: double description: Average rating of Reviews that matched the query parameters. reviews: type: array items: $ref: '#/components/schemas/Review' 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 nextPageToken is only returned with the inclusion of a **`v`** parameter of `20170901` or later. readOnly: true ReviewResponse: description: Review Response content: application/json: schema: title: ReviewResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Review' CreateReviewCommentResponse: description: Create Review Comment Response content: application/json: schema: title: CreateReviewCommentResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: integer description: | If the **`v`** parameter is before `20210616`, **`id`** will be returned as a type string instead of an integer. ReviewCommentTimeoutResponse: description: Review Comment Timeout Response content: application/json: schema: title: ReviewCommentTimeoutResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object GenerateReviewCommentResponse: description: Generate Review Comment Response content: application/json: schema: title: GenerateReviewCommentResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: content: type: string ReviewInvitationsResponse: description: Review Invitations Response content: application/json: schema: title: ReviewInvitationsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: countEmail: type: integer description: Total number of Email Invitations that meet filter criteria (ignores limit/offset) countSMS: type: integer description: Total number of SMS Invitations that meet filter criteria (ignores limit/offset) sent: type: integer description: Total number of Invitations that had a sent time opened: type: integer description: Total number of Invitations that had an open time clicked: type: integer description: Total number of Invitations that had a clicked time responded: type: integer description: Total number of Invitations that had a responded time invitations: type: array items: $ref: '#/components/schemas/GetReviewInvitation' CreateReviewInvitationsResponse: description: Create Review Invitations Response content: application/json: schema: title: CreateReviewInvitationsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: array items: allOf: - $ref: '#/components/schemas/ReviewInvitationOptional' ReviewInvitationResponse: description: Review Invitation Response content: application/json: schema: title: ReviewInvitationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/GetReviewInvitation' UpdateReviewInvitationResponse: description: Update Review Invitation Response content: application/json: schema: title: UpdateReviewInvitationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/UpdatedReviewInvitation' UpdateReviewLabelsResponse: description: Review Labels Update Response content: application/json: schema: title: UpdateReviewLabelsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: integer description: The review id. labelIds: type: array items: type: integer description: The label ids assigned to the review. ReviewGenerationSettingsResponse: description: Review Generation Settings Response content: application/json: schema: title: ReviewGenerationSettingsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/ReviewGenerationSettings' UpdateReviewGenerationSettingsResponse: description: Update Review Generation Settings Response content: application/json: schema: title: UpdateReviewGenerationSettingsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/ReviewGenerationSettings' workflowRulesResponse: description: Workflow Rules Response content: application/json: schema: title: WorkflowRulesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: workflowRules: type: array items: $ref: '#/components/schemas/WorkflowRule' nextPageToken: $ref: '#/components/schemas/NextPageToken' workflowRuleResponse: description: Workflow Rule Response content: application/json: schema: title: WorkflowRuleResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/WorkflowRule' PostsResponse: description: Posts Response content: application/json: schema: title: PostsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: posts: type: array items: $ref: '#/components/schemas/Post' nextPageToken: type: string PostResponse: description: Post Response content: application/json: schema: title: PostResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Post' EntityPostCommentsResponse: description: Entity Post Comments Response content: application/json: schema: title: EntityPostCommentsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: comments: type: array items: $ref: '#/components/schemas/CommentWithReplies' nextPageToken: type: string CreateCommentResponse: description: Create Comment Response content: application/json: schema: title: CreateCommentResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: commentId: type: string description: The ID of a specific comment. text: type: string description: The text of the comment. parentCommentId: type: string description: | If the comment is in response to another comment, this is the ID of the parent comment. UploadVideoResponse: description: Upload Video Response content: application/json: schema: title: UploadVideoResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: videoUrl: type: string description: The Yext CDN URL of the video. fileByteSize: type: number description: The size of the file in bytes. mimeType: type: string description: The mime type of the video. SocialEligibilityResponse: description: Social Eligibility Response content: application/json: schema: title: SocialEligibilityResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: entities: type: array items: type: object properties: entityId: type: string description: The ID of the entity publisher: type: string description: The name of the publisher status: type: string description: The eligiblity status of the entityId/publisher pair enum: - ELIGIBLE - INELIGIBLE statusDetails: type: array items: type: object properties: message: type: string description: A message indicating why the entityId is `INELIGIBLE` for a publisher RolesResponse: description: Roles Response content: application/json: schema: title: RolesResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Roles that meet filter criteria (ignores limit / offset) roles: type: array items: $ref: '#/components/schemas/Role' UsersResponse: description: Users Response content: application/json: schema: title: UsersResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Users that meet the filter criteria (ignores limit / offset) users: type: array items: $ref: '#/components/schemas/User' UserResponse: description: User Response content: application/json: schema: title: UserResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/User' AccountsResponse: description: Accounts Response content: application/json: schema: title: AccountsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer accounts: type: array items: $ref: '#/components/schemas/Account' example: meta: uuid: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 errors: [] response: count: 1 accounts: - accountId: '1264805' locationCount: 11 subAccountCount: 0 accountName: Yext Demo Account contactFirstName: John contactLastName: Doe contactPhone: '1234567890' contactEmail: johndoe@email.com AccountResponse: description: Account Response content: application/json: schema: title: AccountResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Account' example: meta: uuid: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 errors: [] response: accountId: 1264805 locationCount: 11 subAccountCount: 0 accountName: Yext Demo Account contactFirstName: John contactLastName: Doe contactPhone: '1234567890' contactEmail: johndoe@email.com ApprovalGroupsResponse: description: Approval Groups Response content: application/json: schema: title: ApprovalGroupsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer description: Total number of Approval Groups (ignores limit / offset) nextPageToken: $ref: '#/components/schemas/NextPageToken' approvalGroups: type: array items: $ref: '#/components/schemas/ApprovalGroup' ApprovalGroupResponse: description: Approval Group Response content: application/json: schema: title: ApprovalGroupResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/ApprovalGroup' LinkedAccountsResponse: description: Linked Accounts Response content: application/json: schema: title: LinkedAccountsResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: count: type: integer 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 nextPageToken is only returned with the inclusion of a **`v`** parameter of `20170901` or later. linkedAccounts: type: array items: $ref: '#/components/schemas/LinkedAccount' LinkedAccountResponse: description: Linked Account Response content: application/json: schema: title: LinkedAccountResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LinkedAccount' example: meta: uuid: 4f72b877-e2d0-4de4-9324-b9cf2c03e1a0 errors: [] response: id: 3955191 publisherId: GOOGLEMYBUSINESS entityIds: - '3492378' firstName: John lastName: Doe email: johndoe@email.com status: VALID canAssign: true OptimizationTasksResponse: description: Optimization Tasks Response content: application/json: schema: title: OptimizationTasksResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: optimizationTasks: type: array items: $ref: '#/components/schemas/OptimizationTask' OptimizationLinkResponse: description: Optimization Task Links Response content: application/json: schema: title: OptimizationTaskLinksResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: link: type: string description: | The URL where all requested task(s) for the requested location(s) can be completed. Will be null if none of the requested tasks on the requested locations are pending and mode is PENDING_ONLY. **Redirecting after the task:** You can automatically redirect users to a specific URL after they've completed the task. To do so, append a `continueUrl` parameter, whose value is the URL users should be redirected to, to the returned URL. 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. AssetResponse: description: Asset Response. content: application/json: schema: title: AssetResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Asset' PushDataEndpointResponse: description: Get Connector Push Data Response content: application/json: schema: title: GetConnectorPushDataResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: string description: ID of the Connector. runUid: type: integer description: UID of the Run. TriggerConnectorResponse: description: Trigger Connector Response content: application/json: schema: title: TriggerConnectorResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: id: type: string description: | ID of the Connector. If the v param is after `20230215`, the returned value will appear under the `connectorId` property. connectorId: type: string description: | ID of the Connector. If the v param is before `20230215`, the returned value will appear under the `id` property. runUid: type: integer description: UID of the Run. GetConnectorRunResponse: description: Get Connector Run Response content: application/json: schema: title: GetConnectorRunResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: runUid: type: integer description: UID of the Run. status: type: string enum: - CREATED - IN_PROGRESS - COMPLETED - COMPLETED_WITH_ERRORS - FAILED - CANCELED description: Status of the Run. runMode: type: string enum: - DEFAULT - COMPREHENSIVE - DELETION description: Mode of the Run. triggerType: type: string enum: - AUTO - MANUAL description: How the Run was triggered. createdTimestamp: type: number description: The official time the run started (milliseconds since epoch). completedTimestamp: type: number description: The official time the run has been completed (milliseconds since epoch). createdCount: type: integer description: | The number of successfully created entities. If the v param is after `20231114`, the returned value will appear under the `results` property. updatedCount: type: integer description: | The number of successfully updated entities. If the v param is after `20231114`, the returned value will appear under the `results` property. deletedCount: type: integer description: | The number of successfully deleted entities. If the v param is after `20231114`, the returned value will appear under the `results` property. failedCount: type: integer description: | The number of entities that failed to be created or updated. If the v param is after `20231114`, the returned value will appear under the `results` property. unchangedCount: type: integer description: | The number of entities that weren't updated. If the v param is after `20231114`, the returned value will appear under the `results` property. results: $ref: '#/components/schemas/ConnectorRunResults' dryRunResults: $ref: '#/components/schemas/ConnectorRunResults' ApproveRunResponse: description: Approve Run Response content: application/json: schema: title: ApproveRunResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: connectorId: type: string description: ID of the Connector. runUid: type: integer description: UID of the approved Run. CancelRunResponse: description: Cancel Run Response content: application/json: schema: title: CancelRunResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: object properties: connectorId: type: string description: ID of the Connector. runUid: type: integer description: UID of the cancelled Run. 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. 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' CommentResponse: description: Success Response content: application/json: schema: title: SuggestionResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Comment-2' ResourceNamesList: description: List of resource names content: application/json: schema: title: ResourceNamesList type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: type: array items: type: string Resource: description: A resource configuration content: application/json: schema: title: Resource type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Resource' LicenseAssignment: description: Success Response content: application/json: schema: title: License Assignment type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LicenseAssignment' LicensePacks: description: Success Response content: application/json: schema: title: License Packs type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LicensePacks' LicenseAssignments: description: Success Response content: application/json: schema: title: License Assignments type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/LicenseAssignments' ListOperationsResponse: description: List Operations Response content: application/json: schema: title: OperationsResponse type: object properties: meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: description: | If there are more operations than the specified page size there will be pagination data to retrieve the next page of data. type: object properties: pageToken: type: string example: CDk= description: | A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages at that point in time. response: type: object properties: operations: type: array items: $ref: '#/components/schemas/Operation' OperationResponse: description: Operation Response content: application/json: schema: title: OperationResponse type: object properties: meta: $ref: '#/components/schemas/ResponseMeta' response: $ref: '#/components/schemas/Operation' requestBodies: locationRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Location' menuRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Menu' bioRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Bio' productRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Product' eventRequest: required: true content: application/kjson: schema: $ref: '#/components/schemas/Event' commentRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ReviewComment' commentUpdateRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ReviewCommentUpdate' updateReviewInvitationRequest: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReviewInvitationRequest' updateReviewLabelsRequest: content: application/json: schema: $ref: '#/components/schemas/UpdateReviewLabelsRequest' reviewGenerationSettingsRequest: required: true content: application/json: schema: $ref: '#/components/schemas/ReviewGenerationSettings' assetRequest: required: true content: application/json: schema: $ref: '#/components/schemas/Asset' security: - api_key: [] - api-key: [] tags: - name: Health Check - name: Knowledge Manager - name: Listings - name: Analytics - name: Reviews - name: Social - name: Account Settings - name: Optimization Tasks - name: Configuration - name: Licenses - name: Domains - name: Publisher Disruptions