Delete response
Overview
Soft-delete a review response on the platform (sets it back to notresponding, clears flags, records a DeletedResponse row). Best-effort removes the live reply from Google (review_site_id 44) or Facebook (review_site_id 3).
Prerequisites
- A bearer token. Callable with Account tokens.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
GET /api/v1/response/delete
Authentication
-
Requires a bearer token in the
Authorization: Bearer <bearer-token>header. -
Who can call it: Account tokens.
-
Mounted under the account-side
response/*group. -
Scoping is implicit.
response_idloads the response, and the action only proceeds if the underlyingcompany_idis set. Otherwise the endpoint returns 403. -
The request validation only validates existence, not ownership.
Rate limit
- No rate limit.
Query parameters
- Query:
response_id(integer, required) — must be a known response.
Response
data.status(string) —successon an accepted delete. A denied delete is a403error envelope instead:message: "Forbidden"witherrors: { status: "failed", response: "You do not have permission to delete this response." }.data.response(string) — human-readable message. Google path returns the standard 48-hour message. The Facebook path (when the live comment cannot be auto-deleted) returns a message asking the user to delete it in Facebook directly.
200 Success · 200
200{
"data": {
"status": "success",
"response": "We have received your request to delete this review response, and the request will be completed within 48 hours. Thank you"
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The response record is not eligible for deletion |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Example request
curl --request GET \
--url "https://production-api.shoutaboutus.com/api/v1/response/delete?response_id=123" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 8 days ago
Did this page help you?
