Preview alert disable action

Returns the alert’s current title, kind, cadence, and is_active state for a given disable token without redeeming it. Public — token possession is the auth factor.

GET /v1/alerts/disable

cURL

cURL

curl "https://api.particle.pro/v1/alerts/disable?token=%3Ctoken%3E"

200

{
  "alert_id": "<string>",
  "already_disabled": true,
  "delivery_cadence": "<string>",
  "is_active": true,
  "kind": "<string>",
  "manage_url": "<string>",
  "monitor_id": "<string>",
  "title": "<string>"
}

Query Parameters

token · string · required

Disable-alert token from the footer of an alert email.

Response

200

application/json

OK

alert_id · string · required

The alert identified by the supplied token.

already_disabled · boolean · required

True when this click is not the one that changed state — either the token was already redeemed (GET preview after a click, or POST replay), or the alert was already inactive when the token was redeemed. The is_active field reflects the alert's current state, which can diverge from already_disabled if the alert was re-enabled after the token was redeemed.

delivery_cadence · string · required

The alert's delivery cadence (REALTIME, DAILY, or WEEKLY).

is_active · boolean · required

The alert's current is_active flag — false after a successful POST.

kind · string · required

The alert's kind (ENTITY_MENTION or PODCAST_SPEAKER).

manage_url · string · required

Deep-link to the alert's management page.

monitor_id · string · required

Deprecated — use alert_id. The alert identified by the supplied token.

title · string · required

The alert's current title.