Required Action For New Service Area Field

Due to Google product changes, Yext has introduced a new way for businesses to define service areas. This post describes both the new serviceAreaPlaces field, and outlines the actions developers need to take in order to migrate API integrations to use the new field.

What’s changing

Currently, our customers can use the Knowledge API to define their service area as a list of postal codes or cities in the serviceArea field. With Yext’s Fall ‘19 Release, we now support additional service area types, in addition to postal code and city, that give businesses more flexibility with the areas that they service:
  • State/Region
  • County
  • Sublocality
We have also introduced the ability to explicitly specify a type for each of your service areas so that we can more accurately provide your service area information to Google. To accommodate this change, we have introduced a new field in the Entities endpoints called serviceAreaPlaces that is available today. The serviceAreaPlaces field has the following format:
"serviceAreaPlaces": [
        "name": "02670",
        "type": "POSTAL_CODE"
        "name": "Massachusetts"
The name subfield defines your service area and the optional type subfield defines the service area type (one of POSTAL_CODE, REGION, COUNTY, CITY or SUBLOCALITY). Any data you currently store in the serviceArea field has been migrated to the serviceAreaPlaces field and will be kept in sync until the serviceArea field is deprecated on February 15, 2020.

What you need to do

Between now and February 15, 2020, update your integration to use the new serviceAreaPlaces field. Updates made to the legacy serviceArea field via the Entities endpoints after February 15, 2020 will fail and the field will not be returned in any API responses.

If you are currently using the legacy Locations endpoints but would like to take advantage of the new serviceAreaPlaces field, you must upgrade to the Entities endpoints. The serviceArea field will continue to exist in the legacy Location endpoints after February 15, 2020, but any updates made to this field will clear out any service area type data that may have been set via another interface.


If you have any questions about this change or need help migrating your serviceArea field to serviceAreaPlaces field, please contact our API support team.