Remove an account's saved site login

Overview

Remove an account's saved (account-level) login for a review site, the copy that new locations inherit.

You'll need the saved login's id, from Get an account's saved site logins (data.data.id). Call it with the account's own token: a Partner token gets 422 even for an account in its tree.

Only the account-level copy is deleted. Logins already saved on each location are left as they are.

Prerequisites

• The account's own bearer token. See Authentication.
• The saved login's id, from Get an account's saved site logins.

Base URL

Endpoint

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

Authentication

Account token

• The saved login must belong to the account behind the token. A Partner token gets 422, even for an account in its tree.
• An id that doesn't exist, or belongs to another account, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

422 Missing id

{
  "message": "The id field is required.",
  "errors": {
    "id": [
      "The id field is required."
    ]
  }
}

422 Not a saved login of your account

{
  "message": "The selected id is invalid.",
  "errors": {
    "id": [
      "The selected id is invalid."
    ]
  }
}

422 id isn't an integer

{
  "message": "The id field must be an integer.",
  "errors": {
    "id": [
      "The id field must be an integer."
    ]
  }
}

Example request

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