Changelog

May 15, 2024 Release

The updates for this release are automatically available for all versions.


Additional Ownership Detail in Rejected Add Request Statuses

Management API - Agreements

We have added more values to the statusDetail property for rejected API requests made to an Add Requests endpoint . These additional status details help inform when there are instances of duplicates in your own account, in another account, or in your own and another account.


Notify Users Setting for Creating Users via API

Management API - Account Settings

A notifyUser field has been added to the the Create User endpoint . When this field is set to true, an email notification will be sent to the user to confirm user creation.


Content Generation for Review Response Support in CaC & API

Management API - Reviews | Config-as-Code

Users leveraging Generative Review Response can now generate responses via CaC resources and the Reviews API.

Within the CaC API , we have added a new resource: reviews/response-generation-settings. This is where you can add instructions to inform the model on how it should generate review responses based on custom criteria.

We have also added a Comment: Generate endpoint in the Reviews API to generate review responses using AI.

To learn more about Generative Review Response, see this training unit .



April 3, 2024 Release

light bulb
BREAKING CHANGES
This release includes updates with breaking changes. Any update with breaking changes will be noted below along with additional setup details.

Any updates that require specific versioning will be behind v param of 20240515 for this release. When using this new v param, all of those specified updates will be made to your account so it is important that you read the full post for more details.


Add Status Details Title to Listings API

Management API - Listings

Status Details Title is now viewable in the API as unavailableReasonType within statusDetails. This categorizes and gives a title to the previously available message property. To see a full list of possible statuses, see this reference doc .

This feature is included with v param 20240515 or after.


Reviews API Improvements

Management API - Reviews

light bulb
BREAKING CHANGES
This update has breaking changes. Read the full post to learn more.

The following updates have been made to the Reviews API:

  • Updated Reviews: Create Management API endpoint
    • Added support for publisherID.
      • publisherId not included in the request and v param before 20240515 (default to External First Party).
      • publisherId not included in the request and v param equal to or after 20240515 (default to First Party).
    • Added support for externalId. The External ID of the review is typically assigned by the Publisher. Created External IDs must be unique per account and publisher pair.
    • Added support for invitationUid.
    • BREAKING CHANGE. Added support for entityId. This field will replace locationId. Any v param after 20240515 will not accept locationId and require an entityId to be set.
  • Updated Reviews: Update Management API endpoint
    • BREAKING CHANGE. Added support for entityId. This field will replace locationId. Any v param after 20240515 will not accept locationId and require an entityId to be set.
  • Updated Comments: Create Management API endpoint
    • Added support for date.
      • Date is parsed as an ISO-8601 datetime with offset, datetime (assumed UTC), or date (assumed midnight UTC) past the v param date of 20240515.
      • Unifying date behavior across our three different create endpoints (Comment: Create and Review: Create in Review Management, and Review: Create in Review Submission) past the v param date of 20240515.
    • Added support for suppressReviewerContact. suppressReviewerContact should default to false. When suppressReviewerContact == true, we will not contact the reviewer. This field is only settable for first-party reviews.
    • Updated review submission endpoint’s date behavior and stored date as timestamp in API models.


Offset Pagination Deprecation

Management API

light bulb
BREAKING CHANGES
This update has breaking changes. Read the full post to learn more.

As of May 15, 2024, Offset Pagination will no longer be supported for our Management APIs . V params before this date will continue to support offset pagination, but all v params after this date must use our cursor pagination method to paginate requests to the Management API. To utilize cursor pagination, users will need to use the pageToken param instead of the offset param.

Please ensure that API integrations that do not currently use cursor pagination switch to that method, or use a v param before 20240515 until ready to switch.


Updated Review Response Attribution via API

Management API - Reviews

Any new review responses created through the Yext API will not be attributed to a specific Yext user. When a review response is not attributed to a specific Yext user, authorName and authorEmail will be blank in the API response.


Specific Account Scope in Users API

Management API - Account Settings

The onType values have been updated in the Users API. The enum value “EVERYTHING” has been added which gives a user access to an account and all of its sub-accounts. “ACCOUNT” has been updated to only give access to a specific account.

Previously, “ACCOUNT” gave access to an account and all of its sub-accounts.

For brands with sub-accounts that want to give their users access to specific accounts rather than all accounts, they will need to use v param 20240515 or after.


Google Analytics Metrics No Longer Accessible

Management API - Analytics

Google legacy metrics will be inaccessible as of May 15th for all API versions. Any API calls made to fetch the following metrics will return an error response:

  • Google Customer Actions (Legacy): GOOGLE_CUSTOMER_ACTIONS
  • Google Map Views (Legacy): GOOGLE_MAP_VIEWS
  • Google Phone Calls (Legacy): GOOGLE_PHONE_CALLS
  • Google Search Queries (Legacy): GOOGLE_SEARCHES
  • Google Search Views (Legacy): GOOGLE_SEARCH_VIEWS
Feedback