Remove credentials

Overview

Clear the credentials and site-specific detail for a store-review-site row, turns its scraper off, marks it manually disconnected, and emails the account owner.

Prerequisites

  • A bearer token OR an invite hash. Callable with Partner and Account tokens.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

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

Authentication

  • Token flow: Requires a bearer token in the Authorization: Bearer <bearer-token> header. Pass store_review_site_id which must pass an ownership check (Partner or Account hierarchy).

  • Hash flow (tokenless): Requires an invite hash that matches the row's store.

  • Who can call it: Partner and Account tokens.

  • It differs per role only by reachable scope.

Rate limit

  • 30 requests/min.

Request body

  • Body:
FieldTypeRequiredDescription
store_review_site_idintegeryesMust be an existing connected review site inside your own account tree in the token flow.
hashstringhash flow onlyInvite hashid; grants tokenless access for the encoded store.
{
  "store_review_site_id": 5
}

Response

  • data.status (string) — success.
  • data.message (string) — The review site credentials has been removed!.

200 OK · 200

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

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422The request failed validation — the response names the fields
500Unexpected server error

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": 5}'

Did this page help you?