Delete saved company credentials

Overview

Delete a saved company-level review-site login (a company_meta_data row of category review_site).

Prerequisites

  • A bearer token. Callable with Partner and Account tokens.
  • Values for the required query parameter id — see the table below.

Base URL

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

Endpoint

DELETE /api/v1/store-review-site/company/credentials

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • Who can call it: Partner and Account tokens.

  • The request validation requires id to be a saved review-site credential owned by the caller's own company.

  • The record must belong to the caller's own company. A parent Partner passing a child account's credential id gets a 422. The id must match the caller's own company_id.

  • The controller's hierarchy re-check runs only after that stricter validation passes.

Rate limit

  • No rate limit.

Query parameters

  • Query parameter: id (integer, required) — company_meta_data record id (category review_site) owned by the caller's company.

Response

  • data.status (string) — success.
  • data.message (string) — Company review site login deleted successfully. Returns 422 You are not authorized to delete this company review site login when the record is outside the caller's tree.

200 OK · 200

{ "data": { "status": "success", "message": "Company review site login deleted successfully" } }

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422Returned if it is not in the caller's hierarchy
500Unexpected server error

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/company/credentials?id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Did this page help you?