The subscriptions endpoint exposes operations taken on subscriptions.
A subscription represents two things:
-
A podcast feed
-
The relationship between a user and a podcast feed
POST /api/v1/usersWhen a user adds a subscription to the system, a corresponding subscription object is fetched or created depending on whether a matching subscription is present.
A link is then created between the user and the subscription.
operation::subscriptions-bulk-create-mixed[snippets='request-headers,request-fields,curl-request,response-fields,http-response']
If all feeds are valid and no problems are encountered, the server responds with an array of success objects and an empty array of failure objects.
If all feeds are invalid or none could be persisted, the server responds with an array of failure objects and an empty array of success objects.
If the server receives a mix of responses, both arrays are populated.
When a user fetches a list of subscriptions, only their own subscriptions are returned.
operation::subscriptions-list[snippets='request-headers,query-parameters,curl-request,response-fields,http-response']
operation::subscriptions-list-with-unsubscribed[snippets='curl-request,http-response']
Returns the details of a single subscription for the authenticated user.
Returns 404 if the user has no subscription entry for the feed in question.
operation::subscription-get[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']
Unsubscribes the authenticated user from a feed. This action updates the user subscription record to mark the subscription as inactive. It does not delete the subscription record.
operation::subscription-unsubscribe[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']