AIXBT Docs
API v3Reference

Update an alert subscription

PATCH
/v3/alerts/{id}

Partial update: pause/resume, rename, change cadence, selector, threshold, or destinations. Semantics are identical to creation.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v3/alerts/string" \  -H "Content-Type: application/json" \  -d '{    "status": "paused"  }'
{
  "data": {
    "id": "66a10a2b1c9d440000d1e2f3",
    "status": "paused",
    "trigger": "intelligence.material",
    "selector": {
      "followedProjects": true
    },
    "cadence": "hourly",
    "destinationIds": [
      "66a10a2b1c9d440000aa0001"
    ],
    "createdAt": "2026-08-01T10:00:00Z",
    "updatedAt": "2026-08-05T05:10:00Z"
  },
  "meta": {}
}
{
  "code": "invalid_request",
  "message": "minTrend must be numeric",
  "details": {
    "fields": [
      "minTrend"
    ]
  }
}

{
  "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."
}

Get an alert subscription GET

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

List my delivery destinations GET

Read-only list of destinations connected in product Settings (Telegram, Discord, signed webhooks). Creation, secret rotation, and repair stay in Settings; subscriptions reference these ids.