Skip to content

Reply to Review API

The Reply to Review API posts the business owner reply to a Google Business Profile review. A Google Business Profile review has a single owner reply, so sending the request again overwrites the previous reply rather than creating a second one. The operation Costs 1 credit.

Reply to Review API overview and overwrite behavior

Use this endpoint when you need to post or replace the owner reply on a specific Google Business Profile review. Before calling it, obtain the review identifier from listReviews, because reviewId is the review to reply to and accountId is the integration ID of the Google Business Profile location. Treat a second call for the same review as a replacement: the new text replaces any existing reply, so confirm the final wording before sending if you do not want the earlier reply overwritten. The request is sent as POST to {{API_BASE_URL}}/v1/reviews/reply with a JSON body. Authorization uses the accessKey value in the x-access-key header. The operation Costs 1 credit, so include that cost in any retry or batch planning and avoid sending duplicate calls unintentionally.

Endpoint and authorization contract

Send the request with Content-Type application/json and the x-access-key header. The body must contain all four required fields: platform, accountId, reviewId, and text. Set platform to googlebusiness, which is the only supported value today. Set accountId to the integration ID for the Google Business Profile location, reviewId to the identifier returned for the review you want to answer, and text to the owner reply text. The text field must have a length of at least 1. If any required field is missing or the text is empty, do not expect a successful reply; check the request against the field map in the Request body field map table and the worked example in the Reply to a review request example before retrying.

Interpreting responses and checking the result

After a successful call, inspect the 200 response rather than assuming the reply was stored. The response contains success and a reply object with text and updatedAt. Compare reply.text with the text you sent and record reply.updatedAt as the timestamp returned for that reply. For non-200 responses, use the Status code failure matrix to identify the documented status and confirm that the body follows the success and message shape. Do not infer a more specific cause from the status alone, because the documented contract for those statuses only specifies that shape. If you need to change or remove a reply after posting, plan the next step explicitly instead of sending the same request again without checking the current reply text.

Request body field map
FieldTypeRequiredConstraintsDescription
platformstringYesValue in "googlebusiness"Platform the review lives on. Only googlebusiness today.
accountIdstringYes—Integration ID of the Google Business Profile location.
reviewIdstringYes—The review to reply to.
textstringYes1 <= lengthThe owner reply text. Replaces any existing reply.

Exact source contract; origin modularized as {{API_BASE_URL}}.

200 response body field map
FieldTypeRequiredDescription
successbooleanYes—
replyobjectYes—
reply.textstring | nullYes—
reply.updatedAtstring | nullYesResponse reply timestamp field.

Exact source contract for 200.

Status code failure matrix
StatusContent typeResponse shape
200application/jsonsuccess (boolean, required); reply (object, required) with text (string | null, required) and updatedAt (string | null, required)
400application/jsonsuccess (boolean, required); message (string, required)
401application/jsonsuccess (boolean, required); message (string, required)
402application/jsonsuccess (boolean, required); message (string, required)
403application/jsonsuccess (boolean, required); message (string, required)
404application/jsonsuccess (boolean, required); message (string, required)
429application/jsonsuccess (boolean, required); message (string, required)
502application/jsonsuccess (boolean, required); message (string, required)

Statuses and shapes only; per-status error semantics beyond the shape are not specified in the source and are not invented here.

Reply to a review request example
curl -X POST "{{API_BASE_URL}}/v1/reviews/reply" \
  -H "Content-Type: application/json" \
  -H "x-access-key: <token>" \
  -d '{
    "platform": "googlebusiness",
    "accountId": "string",
    "reviewId": "string",
    "text": "string"
  }'
200 response example
{
  "success": true,
  "reply": {
    "text": "string",
    "updatedAt": "string"
  }
}
Error response example for 400, 401, 402, 403, 404, 429, and 502
{
  "success": true,
  "message": "string"
}
Interface fields
ScopeFieldTypeType referenceRequiredDescriptionConstraints
body#1bodyobject__0Yes
body#1body.platformstring__1YesPlatform the review lives on. Only googlebusiness today.kind: schemaValueIn; value: "googlebusiness"
body#1body.accountIdstring__2YesIntegration ID of the Google Business Profile location.
body#1body.reviewIdstring__3YesThe review to reply to.
body#1body.textstring__4YesThe owner reply text. Replaces any existing reply.kind: schemaLength; value: 1 <= length
response#2responseobject__0
response#2response.successboolean__1Yes
response#2response.replyobject__2Yes
response#2response.reply.textstring | null__3Yes
response#2response.reply.text[variant1]string__3_type:string
response#2response.reply.text[variant2]null__3_type:null
response#2response.reply.updatedAtstring | null__4Yes
response#2response.reply.updatedAt[variant1]string__4_type:string
response#2response.reply.updatedAt[variant2]null__4_type:null
response#3responseobject__0
response#3response.successboolean__1Yes
response#3response.messagestring__2Yes