About the Comments API

The Comments API lets you read and manage the feedback left on a site during a review round. A comment is a note pinned to a specific point on a site page, left by a reviewer as part of a feedback session. Studio partners and agencies use it to collect client feedback on a site and work through it without leaving their own tools.

With the Comments API, you can:

  • Retrieve comments left on a site, filtered by feedback session, commenter, or triage status.
  • See who left each comment and who wrote each reply.
  • Track progress through a review round by setting each comment's status.
  • Reply to comments, and edit or remove replies.
  • Delete comments that have been handled or that don't belong.
  • Get notified through webhooks as comments arrive and change.

Comments are created by reviewers in the Wix feedback experience, so this API doesn't create them. It covers everything that happens to a comment afterwards. To open a round of review and get the link reviewers comment through, use the Feedback Sessions API. Every comment carries the ID of its feedback session in feedbackId.

Triage statuses

A comment's status records how far you've got with it:

StatusMeaning
NEWNot read yet. Every comment starts here.
OPENRead, but not dealt with.
RESOLVEDDealt with.

Update Comment Status is the only way for you to change it, and a reviewer can't set the status of their own comment, including when they leave it.

The one status change you don't make yourself is a comment going back to NEW, which the commenter can cause in two ways:

  • When they reply to their own comment, they've come back with something more to say, so the comment returns to NEW whether you'd filed it as OPEN or RESOLVED. Your own replies don't change the status.
  • When they reopen a comment you'd filed as RESOLVED, they're telling you it isn't dealt with after all, so it returns to NEW. They can't reopen a comment that's NEW or OPEN.

What you can and can't change

You moderate comments, but you don't rewrite what other people said:

  • Status is yours to set, on any comment on the site.
  • Comment text and location belong to the commenter, and can't be edited.
  • You can add replies, edit your own replies, and delete any reply.
  • You can delete any comment on the site, along with its replies.

Who wrote a comment or reply

A comment carries the ID of the reviewer who left it in commenterId. To retrieve the reviewer's name and email, specify COMMENTER in fields when you call any method that returns a comment. The comment then includes commenter, with the reviewer's name and, if they gave one, their email.

Each reply's replier says who wrote it:

replier.typeWho wrote the reply
COMMENTERThe reviewer who left the comment. Their name and email are in the comment's commenter, when requested.
WIX_USERA Wix user from the agency that owns the site or from a collaborator account. wixUserOptions.userId is the user who wrote the reply, and wixUserOptions.accountId is the account they were logged in to.

To show a name for a Wix user on your own account, call Search Team. To find your own replies, match wixUserOptions.userId against your user ID: you can update only those replies.

Older replies have no accountId. Treat a Wix user replier with no accountId as the agency that owns the site.

Replies are addressed by position

A comment's replies are an ordered list, and a reply is identified by its index in that list rather than by an ID. Indexes shift when an earlier reply is deleted.

To make that safe, Update Comment Reply and Delete Comment Reply both require the comment's current revision. If the comment changed after you read it, the call is rejected rather than applied to whichever reply now occupies that index. Read the comment, act on it, and pass the revision you just read.

Before you begin

It's important to note the following points before starting to code:

  • Comments are created by reviewers in the Wix feedback experience. There's no endpoint for creating one.
  • Comments are scoped to a single site. Every call resolves within the site in the request context, so a comment on one site is never visible through another. When calling with an API key, specify the site in the wix-site-id header.
  • A comment belongs to a feedback session, which carries an expiration date. A lapsed session accepts no new comments, but you can still triage and reply to the comments already in it.
  • Comments are kept until they're deleted. They aren't removed when their feedback session lapses.

Use cases

Terminology

  • Comment: A note pinned to a specific point on a site page, left while reviewing the site.
  • Feedback session: A round of review on a site. A comment always belongs to one, and a session carries an expiration date after which it accepts no new comments.
  • Commenter: The reviewer who left a comment.
  • Reply: A response to a comment. Replies are ordered oldest first and addressed by their position in the comment's replies list.
  • Triage: Moving a comment through the NEW, OPEN, and RESOLVED statuses as you work through it.

Last updated: 12 October 2026

Did this help?