Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Reviews → Create Comment

AI-generated

Summary

Create a new comment on a specified review within a Yext account, including details like author information, content, visibility, and optional hierarchical reply structure.

Inputs

  • Account Id (required) — Identifier of the Yext account where the review exists.
  • V (required) — API version date in YYYYMMDD format required as a query parameter.
  • Review Id (required) — Numeric ID of the review to which the comment is added.
  • Id — Optional numeric ID of the comment, typically assigned by Yext.
  • Parent Id — Optional numeric ID of a parent comment if this comment is a reply.
  • Publisher Date — Timestamp (number) from the publisher indicating when the comment was made.
  • Author Name — Name of the comment's author if known.
  • Author Email — Email address of the comment's author if known.
  • Author Role — Role of the author; either BUSINESS_OWNER or CONSUMER, defaulting to BUSINESS_OWNER.
  • Content — Text content of the comment.
  • Visibility — Visibility status of the comment, PUBLIC or PRIVATE, defaulting to PUBLIC.
  • Date — Date when the comment was posted; format depends on API version (pre-20240515 YYYY-MM-DD, 20240515+ ISO-8601). Defaults to upload date/time if omitted.
  • Suppress Reviewer Contact — Boolean indicating if the reviewer should not receive email notifications on comment posting; defaults to false.

Output shape

a single record representing the created comment with its metadata

The response includes the created comment resource; no pagination is involved.

Discussion