Yext Live APIInstall

Summary

Update an existing review in the Yext Live API by specifying its unique Api Identifier and providing new review data fields to modify.

Inputs

• Account Id (required) — The Yext account identifier under which the review exists.
• V (required) — API version date in YYYYMMDD format to specify the version of the Live API to use.
• Api Identifier (required) — The unique identifier of the review to update; can be a UUID or invitationUid associated with the review.
• Entity — A JSON object representing the entity data related to the review to send in the request body.
• Author Name — The name of the author who wrote the review.
• Author Email — The email address of the review author.
• Title — The title text of the review.
• Rating — The normalized numerical rating out of 5 given in the review.
• Content — The textual content of the review.
• Status — The status of the review; can be LIVE, QUARANTINED, or REMOVED.
• Review Label Names — A JSON array of review label names to attach to the review; this performs an upsert creating new labels if needed.
• Review Date — The date the review was received from the customer in YYYY-MM-DD format; defaults to the upload date if omitted.
• Url — URL pointing to the review or the listing where the review can be found.
• External Id — External ID assigned by the Publisher unique per account and publisher pair.

Output shape

a single JSON object representing the updated review as returned by the Yext Live API

The operation sends a PUT or PATCH request to update the specified review; response includes the updated review record. Supports batching and request options such as timeouts and proxies as configured on the node level.

Examples

Example 1: Update an existing review's rating and content to reflect new customer feedback.

Provide Account Id, Api Identifier, API version date 'v', and set 'rating' and 'content' fields with new values.