Alerts
tier:free

Disable an alert via email-footer token

Redeems a single-use token from the footer of an alert email and flips the alert's is_active flag to false. Idempotent: a replay returns 200 with already_disabled=true. Public — token possession is the auth factor.

post/v1/alerts/disable

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/alerts/disable
  • Auth: none required

Request body

tokenstring required

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

Response

OK

alert_idstring required

The alert identified by the supplied token.

already_disabledboolean 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_cadencestring required

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

is_activeboolean required

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

kindstring required

The alert's kind (ENTITY_MENTION, PODCAST_SPEAKER, or KEYWORD_MENTION).

manage_urlstring required

Deep-link to the alert's management page.

monitor_idstring required

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

titlestring required

The alert's current title.

Changes

No recorded changes to this operation across all 2 revisions of this API.