Activate a subscriber

post

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

Creates — or reactivates — a subscriber on the current entity and issues their private feed.

If a user already exists with the given e-mail they are reused rather than duplicated, and a
subscription is created for them on this entity.

Set send_welcome_email to send Supercast's welcome message. welcome_email_body is
rendered as Markdown (autolinking and tables enabled) before sending.

plan_id selects the plan for the new subscription. For a network, bundle_id selects the
network bundle the subscription belongs to.

Required scope: write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

minimal

string

When present and non-blank, the response body is omitted and only a status code is returned. Useful for high-volume writes where the serialized record is not needed — serializing a subscriber, for instance, walks the subscription and feed token rows. Any non-blank value enables it; there is no need to pass true.

Body Params

The subscriber key is required — a request without it returns 400. plan_id and bundle_id sit at the top level of the body, alongside subscriber, not inside it.

subscriber

object

required

plan_id

int64

The plan to subscribe the new subscriber to.

bundle_id

int64

Networks only. The network bundle the subscription belongs to.

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

201The created subscriber. When minimal is supplied the body is empty.

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 record matched, or the record exists but does not belong to the entity in scope.

422The subscriber could not be created.

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