alerts

Subscribe

Subscribe an email to a topic's change digest.

Idempotent on (email, kind, target). New and inactive rows enter the mailbox-confirmation queue; active rows remain unchanged. Every accepted request returns the same lifecycle shape so anonymous callers cannot use the endpoint to test membership.

post/api/v1/alerts/subscribe

Request

  • Base URL: https://api.billcommons.org
  • URL: https://api.billcommons.org/api/v1/alerts/subscribe
  • Auth: none declared

Request body

emailstring required
kindstring
targetstring required
jurisdictionstring nullable

Narrow the digest to one jurisdiction, e.g. 'FL'. Omit for a national digest across all 50 states + DC.

Response

Successful Response

subscribedboolean required
lifecyclestring
kindstring required
targetstring required
jurisdictionstring nullable
metaobject required

Changes

No recorded changes to this operation across all 1 revision of this API.