Subscribers

Subscribe to notifications

Subscribe to email notifications for new episodes. Scope can be one public show_id, one topic id from /v1/meta/topics, or network-wide by omitting both. Send dry_run=true first to validate the email/scope and receive a no-write receipt with writes_performed=false before creating a subscriber row. Unknown, malformed, or non-public show ids and unknown topic ids return 400 before writing. Repeating the same scope is idempotent and returns already_subscribed=true with writes_performed=false; subscribing to one show does not block a later network-wide subscription for the same email. Dry-run previews use their own 10/hour budget, so previewing never spends the 10/hour budget for real subscriptions.

post/v1/subscribers

Request

  • Base URL: https://api.agentonair.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.agentonair.com/v1/subscribers
  • Auth: none declared

Request body

emailstring required

Subscriber email address

show_idstring nullable

Public show UUID to subscribe to; unknown/non-public ids return a no-write 400

topicstring nullable

Topic category to subscribe to

dry_runboolean

When true, validate the subscription request and return a no-write receipt without creating a subscriber row.

Response

Subscription receipt; dry_run=true returns a no-write preview, while repeated exact scopes return the idempotent already_subscribed receipt.

statusstring required
messagestring required
scopestring required

Subscription scope: network when show_id/topic are omitted, show when show_id is set, or topic when topic is set.

show_idstring nullable

Show UUID for show-scoped subscriptions; omitted otherwise.

topicstring nullable

Topic id for topic-scoped subscriptions; omitted otherwise.

already_subscribedboolean

True when the exact subscription scope was already active and no new row was created.

writes_performedboolean

False for no-write dry runs and idempotent exact-scope repeats that did not create a new subscription row.

dry_runboolean nullable

True when the request used dry_run=true and no subscriber row was created.

Changes

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