Yext Live APIInstall

Summary

Create a new review for a specified account using Yext Live API by providing detailed review information including author details, rating, content, and optional metadata.

Inputs

• Account Id (required) — The unique identifier of the Yext account for which the review is being created.
• v (required) — A version date string in YYYYMMDD format used as a query parameter for the API.
• Entity (required) — JSON object representing the entity associated with the review.
• Author Name (required) — The name of the person who wrote the review.
• Author Email (required) — The email address of the person who wrote the review.
• Rating (required) — Normalized rating out of 5 given in the review.
• Title — The title of the review.
• Content — The main text content of the review.
• Status — The status of the review, one of LIVE, QUARANTINED, or REMOVED; defaults to QUARANTINED if not specified.
• Review Label Names — JSON array of review label names to attach to the review; performs upsert to add new labels as needed.
• Review Date — Date the review was received in either YYYY-MM-DD or ISO-8601 format depending on the version parameter.
• Invitation Uid — ID of the invitation associated with the review, if any.
• Url — The URL of the review or listing where the review can be found.
• Publisher Id — ID of the publisher for the review; defaults to FIRSTPARTY.
• External Id — A unique external ID assigned by the publisher for the review.

Output shape

a single record containing the created review's details as returned from the Yext API

The output includes the complete response data from the Yext Live API reflecting the newly created review. The operation requires OAuth2 credentials and uses JSON formatted request body with appropriate headers.

Examples

Example 1: Create a review with mandatory fields

Provide Account Id, version date (v), Entity JSON, Author Name and Email, Rating, and optional fields like Title and Content.