Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Reviews → Update Review Generation Settings

AI-generated

Summary

Configure and update review invitation generation settings for a Yext account by specifying parameters such as maximum emails and texts sent per day or month, contact frequency limits, quarantine days for reviews, and site distribution preferences.

Inputs

  • Account Id (required) — The unique identifier of the Yext account whose review generation settings will be updated.
  • V (required) — Version date in YYYYMMDD format, specifying the API version to use for the update.
  • Max Emails Per Day — Maximum number of email review invitations sent per location per day; set to 0 or null to disable email invites.
  • Max Texts Per Day — Maximum number of text review invitations sent per location per day; set to 0 or null to disable text invites.
  • Max Texts Per Month — Maximum number of text invites sent per location per month.
  • Max Contacts All Time — Prevents contacting the same person more than once if set; cannot be combined with maxContactFrequency.
  • Max Contact Frequency — Minimum number of days before a contact can receive another review invitation; disables repeated invitations in short intervals.
  • Review Quarantine Days — Number of days first-party reviews are quarantined before appearing publicly, allowing time to respond or manage reviews.
  • Privacy Policy — URL to a custom privacy policy for review-collection pages; if null, Yext's default privacy policy link is used.
  • Balancing Optimization — Algorithm strategy for generating reviews: prioritize distribution, more reviews, or favor logged-in users on devices.
  • Algorithm Configuration — JSON array to prioritize specific issues when sending review invites, such as WEBSITE, RATING, or RECENCY.
  • Site Distribution — JSON object mapping review sites to integer ratios that control the target distribution of review invitations.

Output shape

no body 1 success/failure only

The operation sends an update request for review generation settings to the Yext Knowledge API; response indicates success or failure but does not return detailed data.

Discussion