Skip to main content

PUT Podcast RSS Redirect

Overview​


Sets or clears the URL that a podcast's RSS feed permanently redirects to. Use it when a podcast moves to another host: podcast apps that read the old feed are sent to the new one and update their subscription.

While a redirect is set:

  • The podcast's RSS feed (rssFeedUrl, for example https://host.vpplayer.tech/{projectId}/podcast/{podcastId}/rss) answers with an HTTP 301 to the redirect URL instead of the feed. The Location header is the redirect URL exactly as saved, query string included (for example ?pageSize=600). The 301 is not cached, so a changed or cleared redirect applies right away.
  • The podcast can't be deleted until the redirect is cleared.

Clearing the redirect brings back the original feed. Podcast apps treat the redirect as a permanent move, so apps that have already followed it may keep using the new feed.

The redirect can be set on podcasts synchronized from an RSS feed too.

PUT Podcast RSS Redirect
MethodPUT
URL or Endpoint/api/v1/projectId/podcasts/podcastId/redirect
HeadersAuthorization
ParametersprojectId, podcastId
BodyCheck the request body below.

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique ID of the project.
podcastIdYesstringUnique ID of the podcast.

Request Body​

{
"redirectUrl": "{redirectUrl}"
}

Information about the fields that appear when you type in the request body are displayed in the table below.

Parameter NameMandatoryTypeDescription
redirectUrlNostring or nullThe URL the RSS feed redirects to. It must be an absolute http or https URL of at most 2048 characters. Send null or an empty string to clear the redirect. The URL is not opened or checked, so make sure it points to the new feed.

Response​

{
"success": true,
"errors": [],
"messages": [],
"result": {
"publicId": "{podcastId}",
"title": "{title}",
"description": "{description}",
"link": "{link}",
"author": "{author}",
"ownerName": "{ownerName}",
"ownerEmail": "{ownerEmail}",
"thumbnailUrl": "",
"thumbnailPath": "",
"canEmbed": true,
"copyright": "{copyright}",
"languageId": 1,
"explicitOptionId": 1,
"rssFeedUrl": "https://host.vpplayer.tech/{projectId}/podcast/{podcastId}/rss",
"redirectUrl": "{redirectUrl}",
"explicitOption": {
"id": 1,
"name": "True",
"value": "true"
},
"categories": [
{
"id": 1,
"name": "Arts",
"subcategories": [
{
"name": "Books",
"id": 1
}
]
}
]
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful, it will return true. Otherwise, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns the response message from the backend.
resultobjectReturns the response object containing the detailed result.
publicIdstringThe public identifier for the podcast.
titlestringThe title of the podcast.
descriptionstringA brief description of the podcast.
linkstringA URL link to the podcast.
authorstringThe name of the author of the podcast.
ownerNamestringThe name of the owner of the podcast.
ownerEmailstringThe email address of the owner.
thumbnailUrlstringThe URL to the thumbnail image for the podcast.
thumbnailPathstringThe path to the thumbnail image for the podcast.
canEmbedboolIndicates if the podcast can be embedded.
copyrightstringCopyright information for the podcast.
languageIdintegerThe ID representing the language of the podcast.
explicitOptionIdintegerThe ID indicating if the podcast has explicit material.
rssFeedUrlstringThe URL of the RSS feed for the podcast.
redirectUrlstring or nullThe URL the podcast RSS feed permanently redirects to. Null when the redirect is cleared.
explicitOptionobjectDetails about the explicit podcast option.
idintegerThe ID of the explicit option.
namestringThe name of the explicit option.
valuestringThe value of the explicit option.
categoriesarray[object]A list of categories associated with the podcast
idintegerThe ID of the category.
namestringThe name of the category.
subcategoriesarray[object]A list of subcategories within a category.
namestringThe name of the subcategory.
idintegerThe ID of the subcategory.
resultInfoobjectAdditional information about the result
statusCodeintegerThe HTTP status code of the response.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors​

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed