v1Resources/Reviews/postReply to a review
Reply to a review
Posts an owner reply to a review and pushes it to the source platform. Fails with a business-rule error (422) if the review isn't respondable — e.g. it was removed from its source.
post
reviews:write/api/v1/reviews/replyRequest body
reviewIdstringrequired
The review to reply to. Required.
textstringrequired
The reply text to post. Required.
Response
dataobjectoptional
okbooleanoptional
Whether the reply was accepted.
pushedbooleanoptional
Whether the reply was actually pushed to the source platform (vs. queued).
statusstring (posted | pending | failed | draft)optional
One of: posted, pending, failed, draft.
externalReplyIdstringoptional
The reply's id on the source platform, or null.
retryablebooleanoptional
When the push failed, whether retrying might succeed — null when not applicable.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
422The request is missing a required parameter or is otherwise malformed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/reply
Your API key
Request body*
{}