Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Reviews → Create Review

AI-generated

Summary

Create a new review associated with a specified entity in the Yext Knowledge API by providing required details such as Account Id, API version date, Entity Id, Author Name, and Rating, along with optional metadata like review content, author email, status, date, publisher Id, external Id, and invitation Uid.

Inputs

  • Account Id (required) — The unique identifier for the Yext account under which the review is created.
  • V (required) — The API version date in YYYYMMDD format to specify the version of the Yext API to use.
  • Entity Id (required) — The ID of the entity that this review is associated with.
  • Author Name (required) — The name of the person who wrote the review.
  • Rating (required) — Normalized rating out of 5 provided by the reviewer.
  • Content — The textual content of the review.
  • Author Email — The email address of the review author.
  • Status — The current status of the review; defaults to 'QUARANTINED' when creating if not specified.
  • Date — The date the review was received from the customer. Format depends on the API version date (v).
  • Publisher Id — The ID of the publisher associated with the review; defaults vary based on the API version date.
  • External Id — Unique external ID for the review assigned by the publisher, unique per entity and publisher pair.
  • Invitation Uid — ID of the invitation that should be associated with this review.

Output shape

a single record representing the created review object as returned by the Yext Knowledge API

The output will include the newly created review details if the operation succeeds. Errors and status codes are returned as per the Yext API behavior. Batch processing can be configured in node settings but the operation itself creates one review per input item.

Discussion