Delete a review widget

Overview

Remove a widget. Sites still embedding it show nothing.

Use this to retire a widget.

You'll need the widget's unique_id.

The widget is removed.

Prerequisites

• A bearer token. See Authentication.
• The widget's unique_id, from List review widgets.

Base URL

Endpoint

DELETE /api/v1/account/widget/delete

Authentication

Partner or Account token

• Send the unique_id of a widget in your own account tree.
• A unique_id that doesn't match a widget is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Sent as JSON in the body of the DELETE request.

Request payload

{
  "unique_id": "abc123"
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "message": "Widget has been deleted successfully",
    "status": "success"
  }
}

Examples

Success payload

See Response payload.

Error payload

422 unique_id is missing

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

422 unique_id doesn't match a widget

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

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/account/widget/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"unique_id": "abc123"}'