Delete widget

Overview

Permanently deletes a widget identified by its unique_id.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

DELETE /api/v1/account/widget/delete

Authentication

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

• Who can call it: Partner and Account tokens.

• Authentication in the role-agnostic account/* group (route name api.brand.widget.delete). No HiPages gate.

• The endpoint validates only that unique_id refers to an existing widget.

• There is NO ownership check on delete. Any authenticated user (partner or account) who knows a valid unique_id can delete that widget.

• Identical params for both roles.

Rate limit

• No rate limit.

Request body

• Body:

{
  "unique_id": "abc123"
}

Response

• data.message (string)
• data.status (string) — success

200 OK · 200

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

422 Validation error · 422

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

Errors

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