Disconnect response posting

Overview

Remove a site's posting authorization or saved credentials.

Use this when a location no longer wants replies posted on a site, or to reset a broken authorization before reconnecting.

You'll need the store_review_site_id.

The saved username and password (and any site-specific details, such as the BBB owner or the Caring id) are cleared, posting status changes to not connected, and review collection for the site is switched off. The account owner is emailed that the site was disconnected. The review URL is kept, so turn collection back on with Turn review collection on or off. To post again, send a new connection link.

Prerequisites

• A bearer token, or the invite hash from a connection link. See Authentication.
• The connection's store_review_site_id, from List a location's review sites.

Base URL

Endpoint

POST /api/v1/store-review-site/remove

Authentication

Partner or Account token

• The connection must be on a location inside your own account tree. A Partner token reaches any location under the partner; an Account token only its own account's locations. Otherwise 422.
• Or, with no token: send the invite hash (the token from Send the business owner a connection link). The connection must be on the location the hash is for.

Rate limit

30 requests per minute, counted per client IP address. See Rate limits.

Request parameters

None.

Request body

Request payload

{
  "store_review_site_id": 8782
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "status": "success",
    "message": "The review site credentials has been removed!"
  }
}

Examples

Success payload

See Response payload.

Error payload

422 Missing store_review_site_id

{
  "message": "The store review site id field is required.",
  "errors": {
    "store_review_site_id": [
      "The store review site id field is required."
    ]
  }
}

422 Connection outside your tree

{
  "message": "The selected store review site id does not belong to your company hierarchy.",
  "errors": {
    "store_review_site_id": [
      "The selected store review site id does not belong to your company hierarchy."
    ]
  }
}

422 Invalid hash

{
  "message": "Invalid or expired token.",
  "errors": {
    "hash": [
      "Invalid or expired token."
    ]
  }
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/remove" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"store_review_site_id": 8782}'