Back
Step 2: Respond to Reviews
Overview
As you probably know, Yext supports Review Response for certain publishers in the network, including Google & Facebook. The Management API Comments endpoints allow you to create, update, and delete review responses programmatically. Throughout this guide and the API documentation, “Comment” is used interchangeably with “Response”.
To create a new comment, you would use the Comment: Create endpoint.
Comment: Create - Endpoint Information:
| Element | Description |
|---|---|
| URL | https://api.yextapis.com/v2/accounts/{accountId}/reviews/{reviewId}/comments |
| Permissions | Reviews: WRITE |
| Description | Creates a new Comment on a Review. |
Example Request:
Example Request Body:
{
“content”: “Thank you for visiting the restaurant! We’re glad you had a good experience.”
}Note: Optionally, for Facebook Comments, you can specify a parentId in the request body in a Comment: Create request, in order to reply to a specific comment rather than the original review.
To update an existing comment, you would use the Comment: Update endpoint.
Comment: Update - Endpoint Information:
| Element | Description |
|---|---|
| URL | https://api.yextapis.com/v2/accounts/{accountId}/reviews/{reviewId}/comments/{commentId} |
| Permissions | Reviews: WRITE |
| Description | Updates an existing Comment on a Review. |
Example Request:
Example Request Body:
{
“content”: “Thank you for visiting again to give us another chance! We’re so glad you had a positive experience this time.”
}To delete an existing comment, you would use the Comment: Delete endpoint.
Comment: Delete - Endpoint Information:
| Element | Description |
|---|---|
| URL | https://api.yextapis.com/v2/accounts/{accountId}/reviews/{reviewId}/comments/{commentId} |
| Permissions | Reviews: WRITE |
| Description | Deletes an existing Comment on a Review. |
Example Request: