Since we launched v2 of our APIs in early November, we’ve been working hard to make improvements and increase their capabilities. We’re excited to announce that our APIs now include the following features and enhancements.
We recently released our Administrative API, as well as several endpoint groups in the Location Cloud API.
The Administrative API lets Yext Partners manage their accounts and any sub-accounts they’ve created for their customers.
If you’re a Yext Partner, you can use the Administrative API to:
- View information about your account or a sub-account
- See a list of services that you can offer to your customers
- Add services to a new location or to one you’ve already created
- Check the status of a request to add services to a location
- Cancel a location’s services
If you used v1 of our API to perform these tasks in the past, you will notice that the structure of the Administrative API in v2 differs from that of v1. We encourage Yext Partners to upgrade to v2, as the structure of the new Administrative API makes the development process simpler. For more information, see the Administrative API guide and the Administrative API documentation. To ensure that you can upgrade to v2 with your current subscription, contact your Account Manager.
Location Cloud API
The following endpoint groups in the Location Cloud API are now available.
Menus, Bios, Products, and Events
While the Location data model lets you tell consumers a great deal about your business, including your hours and website, you may want to tell them even more about makes your locations special. To help consumers understand what differentiates your business, Yext offers four exclusive data types:
- Menus — lets consumers know what food and drinks you serve at your location
- Bios — introduces potential customers to your staff members
- Products — lists the products and services your location offers
- Events — gives consumers a calendar of events being held at your location
These data types, also called “Lists”, are created at the Account level, rather than for individual Locations. You can associate a List with one or more Locations via the Location endpoint group. Your Lists are published across your listings on most PowerListings® Network publishers and can also appear on your Pages.
Each of these List types has its own endpoint group in our Location Cloud API, which allow you view and manage your account’s Menus, Bios, Products, and Events. To learn more about these endpoint groups, see the Location Cloud API documentation.
If you would like to make your location data available in multiple languages, you can use Language Profiles to provide language-specific values for Location fields. This feature helps you maximize the potential of your listings and Pages in regions where more than one language is commonly spoken.
The Language Profiles endpoints allow you to create and manage Language Profiles for your account’s Locations. More information about these endpoints can be found in the Location Cloud API documentation.
The User endpoints allow you to:
- manage users in your Yext account,
- change users’ passwords, and
- see what roles (permission sets) your users can have, including any custom roles we’ve created for your account.
If you’re onboarding new local managers, franchisees, or team members, this endpoint group makes it easy to give them access to Yext.
This update also allows Yext Partners to see which profile optimization tasks are available to customers and retrieve links for specific tasks, like adding photos to their listings or updating their hours. Partners can then send those links to their customers to make it easy for them to add fresh content to Yext.
To learn more about the User endpoints, see the Location Cloud API documentation.
In addition to adding new features, we’ve made the following improvements to our API and the API user experience.
We’ve added the following fields to the Location data model:
To learn more about these fields, see the Location Cloud API documentation.
When sending API requests, you can now choose between Lenient and Strict validation modes. You can learn more in the Policies and Conventions section of our API documentation.
If you would like to attribute PUT, POST, or DELETE requests to a particular user, you can do so by including actor headers in your requests. To learn more, see the Policies and Conventions section of our API documentation.
If you need assistance using any of these features or would like more information, please contact our API Support team.