AIXBT Docs
API v3Reference

Delete an alert subscription

DELETE
/v3/alerts/{id}

Removes the subscription; delivery history retention is unaffected.

Authorization

ApiKeyAuth
x-api-key<token>

API key. The Authorization header is accepted as an equivalent carrier. Responses echo the credential class in X-API-Key-Type.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v3/alerts/string"
Empty

{
  "code": "credential_required",
  "message": "Provide an API key via the x-api-key header."
}

{
  "code": "not_found",
  "message": "No Project matches that locator.",
  "details": {
    "subject": {
      "type": "project",
      "locator": "examplechain"
    }
  }
}

{
  "code": "rate_limited",
  "message": "Minute limit reached.",
  "details": {
    "limit": 30,
    "window": "minute"
  }
}
{
  "code": "internal_error",
  "message": "Unexpected error."
}

Create an alert subscription POST

Creates an owner-scoped subscription: selector + one trigger + delivery cadence + explicit destination ids. Destinations are provisioned in product Settings and referenced here by id. Chat cadence defaults to `hourly`; `instant` is subject to a per-day platform safety ceiling. Webhook destinations receive every admitted event regardless of cadence. The 50-subscription owner cap and selector list bounds (20 values per list) are enforced. An account holds at most one `rank.entered` subscription; creating a second while one exists fails with `invalid_request`.

Get an alert subscription GET

Owner-scoped read; another owner's id behaves as `not_found`.