The subscriptions endpoint exposes operations taken on subscriptions.
A subscriptionEntity 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 subscriptionEntity object is fetched or created depending on whether a matching subscriptionEntity is present.
A link is then created between the user and the subscriptionEntity.
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, their own subscriptions are returned. The subscriptions of other users are not 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 subscriptionEntity for the authenticated user.
Returns 404 if the user has no subscriptionEntity entry for the feed in question.
operation::subscriptionEntity-get[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']
Unsubscribes the authenticated user from a feed. This action updates the user subscriptionEntity record to mark the subscriptionEntity as inactive. It does not delete the subscriptionEntity record.
operation::subscriptionEntity-unsubscribe[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']