To give you more flexibility in how you manage—and maximize—your business’s digital knowledge, we’ve made the following enhancements to our APIs as part of the Winter ’18 Release.
We’ve released some new endpoints, as well as a new webhook.
Review Invitations Webhook
If your app handles the delivery of review invitations (e.g., the app that sends emails or text messages to consumers inviting them to leave reviews on Trustpilot), you can use the Review Invitations Webhook to receive notifications when new invitations for your account are ready to be sent. The webhook will also provide information about each invitation, including the location to be reviewed, the consumer’s name, and whether the invitation should be sent via email or text message.
To learn more, see the Webhook documentation.
Review Invitation: Update endpoint in the Knowledge API
If you sent review invitations outside of Yext, you can use the Review Invitation: Update endpoint to provide information about those invitations. For example, you can indicate the time each invitation was sent, when each invitation was opened, and the time the resulting review was generated.
For more details about this endpoint, see the Knowledge API documentation.
Accounts: Update endpoint in the Administrative API
We’ve added the Accounts: Update endpoint, which allows you to change the accountId or accountName for the accounts you manage.
For more information, see the Administrative API documentation.
In addition to adding new features, we’ve made the following improvements to our APIs and the developer experience.
New sort options for Locations: GeoSearch and Locations: List endpoints
The sortBy parameter in the Live API’s Locations: GeoSearch and Locations: List requests now allows you to sort your results by firstName, lastName, and text custom fields. You can also specify whether the results should be sorted in ascending or descending order. For example, to sort your results alphabetically by lastName, you would specify “lastName” as the sort field and “ASCENDING” as the sort direction.
To learn more about the sortBy parameter, see the Live API documentation.
Filtering Locations by folder
The filters parameter in the Live API’s Locations: List and Locations: GeoSearch endpoints now allows you to filter your results by multiple folders. Prior to this release, you needed to send separate requests for each folder you wanted to filter by. This filter is also available in Locations: Search requests in the Knowledge API.
Improved sorting of Listings: List responses
Prior to this release, responses to the Knowledge API’s Listings: List requests were sorted first by locationId, then by publisherId. To make the results more useful for developers, Listings: List responses are now sorted first by publisherId, then by locationId.
To learn more about the Listings: List endpoint, see the Knowledge API documentation.
Ability to retrieve full or partial Language Profiles
The rendered parameter in the Live API’s Language Profiles: Get and Language Profiles: List requests lets you specify whether the responses should contain full location profiles in the requested languages, including data that remains the same across languages (e.g., phone), or only language-specific fields.
For more information about the Language Profiles: Get and Language Profiles: List endpoints, see the Live API documentation.
Filtering Analytics data by review labels
We’ve added a reviewLabels filter to the Create Reports endpoint, which allows you to filter your Analytics data to include results for reviews that have the labels you specify. This filter can only be used with Reviews metrics.
For more details about the filters available to you when creating Analytics reports, see the Knowledge API documentation.
New API fields
We’ve added the following fields to our APIs:
- primaryContact – indicates the user who is the primary Knowledge Assistant for the Location
- reviewResponseConversationEnabled – indicates whether or not review-response conversations are enabled for Knowledge Assistant
- holidayHoursConfirmationEnabled – indicates whether or not holiday-hour alerts are enabled for Knowledge Assistant
- sourceUrl – the URL of the source the menu’s content is retrieved from
If you would like more information about any of these features, or if you need assistance using them, please contact our API Support team.