v1Resources/Reviews/postReply to a review

Reply to a review

Posts the owner reply to a review, or replaces it: a review has one reply, so a second call edits the first (Google updates it; on Facebook our reply comment is edited). pushed: false means the reply isn't live yet: either the platform accepted it and is still publishing it (status pending), or the platform has no reply API and it's saved in Synup only. Fails with 422 if the review can't be replied to or the platform refused it; retryable says whether trying again can succeed.

post/api/v1/reviews/reply
reviews:write
Request 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 is live on the source platform. False while the platform is still publishing it (status pending), or when the platform has no reply API and the reply is saved in Synup only.
statusstring (posted | pending | failed | draft)optional
One of: posted, pending, failed, draft.
externalReplyIdstringoptional
The reply's id on the source platform, or null.
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*
{
  "data": {
    "ok": true,
    "pushed": true,
    "status": "posted",
    "externalReplyId": "ext_reply_123",
    "retryable": null
  }
}

Guides that use this endpoint