Deactivate a subscriber

delete

https://{subdomain}.supercast.com/api/v1/subscribers/{id}

Cancels the subscriber's subscription to the current entity and deactivates all of its feed
tokens, so their private feed stops serving new episodes.

The user record itself is not deleted, and neither are their subscriptions to other entities.

{id} accepts a Supercast uuid, e-mail address, or customer_id, resolved exactly as in
GET /subscribers/{id}. If the resolved subscriber has no subscription to the current
entity the request returns 404.

Required scope: write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The subscriber's Supercast uuid, e-mail address, or customer_id (the payment gateway's customer identifier). Matched in that order of preference: e-mail, then uuid, then customer_id.

Query Params

channel_subdomain

string

Selects which channel or network the request acts on.

This applies to every endpoint in this API, not only GET /episodes. Its requirement
depends on what the access token's resource owner is:

Channel token — ignored. The token already identifies the channel.
Network token — optional. Omit it to act on the network itself; supply the subdomain
of one of the network's channels to act on that channel instead. An unrecognised subdomain
returns 400.
User or superapp token — required. The token is not bound to an entity, so the
target must be named on every request. Omitting it returns 400; naming an entity the user
does not manage returns 403.

The X-CHANNEL-SUBDOMAIN header takes precedence over this parameter. A legacy subdomain
query parameter is also still accepted as a fallback.

bundle_id

int64

Network tokens only. Selects which network bundle's subscription to act on, for a subscriber who holds more than one. Ignored for channel tokens.

recursive

string

Network tokens only. When present, the subscriber lookup searches across the network and all of its channels rather than the network's own subscribers alone. Any non-blank value enables it — only the presence of the key is checked. Ignored for channel tokens.

Headers

X-CHANNEL-SUBDOMAIN

string

Header form of channel_subdomain, and the preferred one — it takes precedence over both the channel_subdomain and legacy subdomain query parameters. See channel_subdomain for when a value is required.

Responses

200The subscription was cancelled.

400The request was malformed — a required body key was missing, or a supplied channel_subdomain did not resolve to an entity, or a filter parameter such as updated_since was not parseable.

401No access token was supplied, or the token is invalid, expired, or revoked. Also returned when the token lacks the scope the endpoint requires.

403The token is valid but not permitted to act here — the requesting user does not manage the named entity, or the caller's IP address is on the channel's block list.

404No subscriber matched, or the subscriber has no subscription to the current entity.

422The request was well-formed but could not be completed — typically model validation failure. errors maps each rejected attribute to its messages.

500An unexpected error occurred. The failure is reported to Supercast automatically.