Skip to content
Open Podcast API

Add new subscriptions for the authenticated user

POST
/v1/subscriptions

Add one or more new subscriptions for the authenticated user by passing an array of feed URLs in the request body

Authorizations

Request Body

An array of feeds the user wants to subscribe to

object
subscriptions
required
Array<object>
object
feed_url
required
string
guid
string
[
  {
    "feed_url": "https://example.com/feed1"
  },
  {
    "feed_url": "https://example.com/feed2"
  },
  {
    "feed_url": "https://example.com/feed3"
  },
  {
    "feed_url": "example.com/feed4",
    "guid": "2d8bb39b-8d34-48d4-b223-a0d01eb27d71"
  }
]

Responses

200

Successful operation

object
success
Array<object>
object
feed_url
required
string format: url
guid
required
string format: guid
is_subscribed
required
boolean
subscription_changed
required
string format: date-time
failure
Array<object>
object
feed_url
required
string format: url
message
required
string
{
  "success": [
    {
      "feed_url": "https://example.com/rss1",
      "guid": "8d1f8f09-4f50-4327-9a63-639bfb1cbd98",
      "is_subscribed": true,
      "subscription_changed": "2023-02-23T14:00:00.000Z"
    },
    {
      "feed_url": "https://example.com/rss2",
      "guid": "968cb508-803c-493c-8ff2-9e397dadb83c",
      "is_subscribed": true,
      "subscription_changed": "2023-02-23T14:00:00.000Z"
    },
    {
      "feed_url": "https://example.com/rss3",
      "guid": "e672c1f4-230d-4ab4-99d3-390a9f835ec1",
      "is_subscribed": true,
      "subscription_changed": "2023-02-23T14:00:00.000Z"
    }
  ],
  "failure": [
    {
      "feed_url": "example.com/rss4",
      "message": "No protocol present"
    }
  ]
}

401

Unauthorized

object
code
required
string
message
required
string
Example
{
  "code": 401,
  "message": "User not authorized"
}

405

Validation exception

object
code
required
string
message
required
string
Example
{
  "code": 405,
  "message": "Input could not be validated"
}