Remove a response
Overview
Take down a reply you've posted.
Use this when a reply was posted in error or needs to come down before a corrected one goes up.
You'll need the response id.
The reply is removed from the review. Where the site allows it, the live reply is taken down too.
Prerequisites
- A bearer token. See Authentication.
- The response's id (
response_id):data.response.idfrom Get one review.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
GET /api/v1/response/delete
Authentication
Partner or Account token
- The response must belong to a location inside your own account tree. A Partner token can remove responses on any location under the partner; an Account token only on its own locations.
- A response outside your tree returns
403.
Rate limit
This endpoint has no rate limit.
Request parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
response_id | query | integer | Yes | The response to remove. Must exist. |
Request body
None.
Request payload
None.
Response body
The payload is inside data.
| Field | Type | Description |
|---|---|---|
status | string | success. |
response | string | What happens next. Usually that the request will be completed within 48 hours. For a Facebook reply that couldn't be taken down automatically, it asks you to delete the reply in Facebook yourself. |
Response payload
{
"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"
}
}Examples
Success payload
See Response payload.
A Facebook reply that couldn't be taken down automatically:
{
"data": {
"status": "success",
"response": "Deleting the response through our platform will not delete the response on the live site. Please log into Facebook to delete the response."
}
}Error payload
403 Response outside your tree
{
"message": "Forbidden",
"status": "error",
"errors": {
"status": "failed",
"response": "You do not have permission to delete this response."
}
}422 Response doesn't exist
{
"message": "The selected response id is invalid.",
"errors": {
"response_id": [
"The selected response id is invalid."
]
}
}422 response_id missing
{
"message": "The response id field is required.",
"errors": {
"response_id": [
"The response id field is required."
]
}
}| Status | Meaning |
|---|---|
200 | The response is removed and the live reply is queued for removal where the site allows it. |
401 | The token is missing, expired or invalid. |
403 | The response belongs to a location outside your tree. |
422 | response_id is missing, isn't an integer or doesn't exist. |
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 18 days ago
Did this page help you?
