post https://partner-api.yelp.com/v1/ingest/create
The Yelp Data Ingestion API provides a means for partners to programmatically perform updates on a large number of businesses asynchronously. Partners can perform updates on various attributes. The businesses and fields that can be updated are contract-dependent.
{
"businesses": [
{
"matching_criteria": {
"address1": "800 N Point St",
"address2": null,
"address3": null,
"city": "San Francisco",
"country": "US",
"latitude": 37.8058024,
"longitude": -122.420582,
"name": "Gary Danko",
"phone": "+14157492060",
"postal_code": "94109",
"state": "CA",
"yelp_business_id": "WavvLdjbuy6g8aZTtbBQHTw"
},
"options": {
"create_if_missing": false,
"use_matching_criteria_for_update": false
},
"partner_business_id": "12345",
"update": {
"accepts_credit_cards": true,
"alcohol": "full_bar",
"categories": [
"newamerican"
],
"caters": false,
"delivery": false,
"has_tv": false,
"is_customer": false,
"is_owner_verified": true,
"parking": {
"garage": false,
"lot": false,
"street": false,
"valet": true,
"validated": false
},
"wifi": "no"
}
}
]
}
Updatable Business Attributes
Please reference the table below for supported 'Business' attributes. To see other Data Ingestion supported resources please check out our Data Ingestion Guide
Property Name | Value | Required | Description |
---|---|---|---|
matching_criteria | object | Yes | Provides information to find a matching business on Yelp. |
matching_criteria.address1 | string | No | The first line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.': are allowed. |
matching_criteria.address2 | string | No | The second line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.': are allowed. |
matching_criteria.address3 | string | No | The third line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.': are allowed. |
matching_criteria.city | string | Yes | The city of the business. Maximum length is 64; only digits, letters, spaces, and _-’.() are allowed. |
matching_criteria.country | string | Yes | The ISO 3166-1 alpha-2 country code of the business. Maximum length is 2. |
matching_criteria.latitude | double | No | The WGS84 latitude of the business in decimal degrees. Must be between -90 and 90. |
matching_criteria.longitude | double | No | The WGS84 longitude of the business in decimal degrees. Must be between -180 and 180. |
matching_criteria.name | string | Yes | The name of the business. Maximum length is 64; only digits, letters, spaces, and _!#$%&+,-.’/:?@' are allowed. |
matching_criteria.phone | string | No | The phone number of the business, either (a) locally-formatted with digits only (e.g., 016703080) or (b) internationally-formatted with a leading + sign and digits only after (+35316703080). Maximum length is 32. |
matching_criteria.postal_code | string | Yes | The postal code of the business. Maximum length is 12. |
matching_criteria.state | string | Yes | The ISO 3166-2 code for the region/province of the business. Maximum length is 3. |
matching_criteria.yelp_business_id | string | No (Required in phase 1 only) | Unique Yelp identifier of the business if available. Used as a hint when finding a matching business. |
options | object | Options for handling the business. | |
options.create_if_missing | boolean | Whether to create the business if no matching business is found. Defaults to true if not specified. | |
options.use_matching_criteria_for_update | boolean | Whether to use the information in the matching criteria to also update the business. When true, the fields from the matching_criteria are merged into the update object. Any fields already present in the update object take precedence. Defaults to false if not specified. | |
partner_business_id | string | Optional unique partner identifier for the business. Must not contain leading or trailing spaces. When provided, partner identifiers cannot change and must remain unique. Maximum length is 100. | |
update | object | Provides rich content for the business. | |
update.about_this_business_history | string | The history of the business. Minimum length is 15, maximum is 1,000; URLs, all caps, and HTML tags are not allowed. | |
update.about_this_business_specialties | string | The specialties of the business. Minimum length is 15, maximum is 1,000; URLs, all caps, and HTML tags are not allowed. Business description will map to this attribute. | |
update.about_this_business_year_established | string | The 4-digit year that the business was established. Year must be no greater than the year following today’s date (e.g., 2015 on 5/1/2014). | |
update.accepts_credit_cards | boolean | Whether the business accepts credit cards for payments. | |
update.address1 | string | The first line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.: are allowed. | |
update.address2 | string | The second line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.: are allowed. | |
update.address3 | string | The third line of the business’s address. Maximum length is 64; only digits, letters, spaces, and _-’/#&,.: are allowed. | |
update.alcohol | string | Whether the business serves alcohol. Possible values are: "none" - No alcohol is served. "beer_and_wine" – Only beer & wine are available. "full_bar" – Beer, wine & spirits are available. | |
update.by_appointment_only | boolean | Whether the business views patrons by appointment only. | |
update.categories[] | list | The categories, as Yelp aliases, for the business. Case-sensitive. Maximum of 3 leaf categories. Yelp aliases can be found at the Category List Page or using the Categories API endpoint. | |
update.caters | boolean | Whether the business offers catering. | |
update.city | string | The city of the business. Maximum length is 64; only digits, letters, spaces, and -’.() are allowed. | |
update.closed | boolean | Whether the business is permanently closed. | |
update.coat_check | boolean | Whether the business offers a coat check. | |
update.comment | string | Optional comment, preferably from the end user, for this update. Maximum length is 4,500; all caps and HTML tags are not allowed. | |
update.country | string | The ISO 3166-1 alpha-2 country code of the business. Maximum length is 2. | |
update.delivery | boolean | Whether the business offers delivery. | |
update.desktop_cta | nested object | Create, update, or end a desktop call to action offer using a Call to Action – Desktop resource. | |
update.display_url | string | The URL to display on the page. This field can only be set when "url" is also set. "displayurl" and "url" cannot have the same value. Maximum length is 255; only digits, ASCII letters, and !"#$%&'()*+,-./:;<=>?@[]^`{|}~ are allowed. Must start with http:// or https://. Links to Facebook, Twitter, Google Plus, or other directories are not allowed in most cases. | |
update.dogs_allowed | boolean | Whether dogs are allowed at the business. | |
update.group_bookings | boolean | Whether business offers group bookings. | |
update.happy_hour | boolean | Whether the business has a happy hour. | |
update.has_tv | boolean | Whether the business has televisions. | |
update.hours[] | list | The operating hours of the business. Multiple entries can exist for the same day (e.g., a business is open for lunch and dinner but closes in between). To set a business open 24 hours, set both the "open" and "close" fields to 00:00. To set a business to be closed for a specific day of the week, don't include that day in the list. | |
update.hours[].day | string | The full day of the week, in English, for the hours. Possible values are: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday" | |
update.hours[].open | time | The time the business opens on the specified day. | |
update.hours[].close | time | The time the business closes on the specified day. The close time can be earlier than the open time if the business closes the following day (e.g., opens at 7 PM and closes at 2 AM). | |
update.is_customer | boolean | Whether the business is a paying client. This is used to indicate the relationship a partner has with the business. false is assumed unless provided. | |
update.is_owner_verified | boolean | Whether the owner of the business has verified its information. false is assumed unless provided. | |
update.latitude | double | The WGS84 latitude of the business in decimal degrees. Must be between -90 and 90. | |
update.longitude | double | The WGS84 longitude of the business in decimal degrees. Must be between -180 and 180. | |
update.menu_data | nested object | Menu data, as a Menu Data resource, for the business. | |
update.menu_url | string | The business’s menu URL. Maximum length is 2,000; only digits, ASCII letters, and !"#$%&'()*+,-./:;<=>?@[]^_`{|}~ are allowed. Must start with http:// or https://. Links to Facebook, Twitter, Google Plus, or other directories are not allowed in most cases. | |
update.mobile_cta | nested object | Create, update, or end a mobile call to action offer using a Call to Action – Mobile resource. | |
update.name | string | The name of the business. Maximum length is 64; only digits, letters, spaces, and _!#$%&+,-./:?@' are allowed. | |
update.parking | object | The types of parking available for the business. | |
update.parking.garage | boolean | Whether a garage or deck is available. | |
update.parking.lot | boolean | Whether a lot is available. | |
update.parking.street | boolean | Whether street parking is available. | |
update.parking.valet | boolean | Whether valet parking is available. | |
update.parking.validated | boolean | Whether validated parking is available. | |
update.metered_phone | string | The call tracking number of the business, either (a) locally-formatted with digits only (e.g., 016703080) or (b) internationally-formatted with a leading + sign and digits only after (+35316703080). Maximum length is 32. If metered_phone is sent, then the phone must also be sent. | |
update.phone | string | The phone number of the business, either (a) locally-formatted with digits only (e.g., 016703080) or (b) internationally-formatted with a leading + sign and digits only after (+35316703080). Maximum length is 32. | |
update.photo[] | list | Photos, as Business Photo resources, for the business. | |
update.platform_service | nested object | Platform service information, as a Platform Service resource, for the business. | |
update.postal_code | string | The postal code of the business. Maximum length is 12. | |
update.opening_date | date | The date the business opened. Must be in the past. | |
update.outdoor_seating | boolean | Whether the business offers outdoor seating. | |
update.service_area[] | list | The additional locations serviced by the business. Locations must be expressed as unambiguous postal codes or neighborhood- city-state-country combinations. Maximum of 6 locations; distance between locations cannot exceed 100 miles. | |
update.smoking | string | Whether smoking is allowed at the business. Possible values are: "no" – Smoking is not allowed. "yes" – Smoking is allowed. "outdoor" – Smoking is only allowed outside. | |
update.state | string | The ISO 3166-2 code for the region/province of the business. Maximum length is 3. | |
update.take_out | boolean | Whether the business offers take-out. | |
update.takes_reservations | boolean | Whether the business takes reservation. | |
update.url | string | The business’s website URL. Maximum length is 255; only digits, ASCII letters, and !"#$%&'()*+,-./:;<=>?@[]^_`{|}~ are allowed. Must start with http:// or https://. Links to Facebook, Twitter, Google Plus, or other directories are not allowed in most cases. | |
update.waiter_service | boolean | Whether the business has waiter service. | |
update.wheelchair_accessible | boolean | Whether the business is wheelchair-accessible. | |
update.wifi | string | Whether the business offers Wi-Fi. Possible values are: "no" – WiFi is not available. "paid" – Paid WiFi is available. "free" – Free WiFi is available. | |
update.linkout_data | nested object | linkout information as a Linkout Data resource, for the business. |
This endpoint is part of the Data Ingestion API, visit Data Ingestion API to learn more.