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 examplehttps://host.vpplayer.tech/{projectId}/podcast/{podcastId}/rss) answers with an HTTP 301 to the redirect URL instead of the feed. TheLocationheader 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 | |
|---|---|
| Method | PUT |
| URL or Endpoint | /api/v1/projectId/podcasts/podcastId/redirect |
| Headers | Authorization |
| Parameters | projectId, podcastId |
| Body | Check the request body below. |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
projectId | Yes | string | Unique ID of the project. |
podcastId | Yes | string | Unique 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 Name | Mandatory | Type | Description |
|---|---|---|---|
redirectUrl | No | string or null | The 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 Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from the backend. |
| result | object | Returns the response object containing the detailed result. |
| publicId | string | The public identifier for the podcast. |
| title | string | The title of the podcast. |
| description | string | A brief description of the podcast. |
| link | string | A URL link to the podcast. |
| author | string | The name of the author of the podcast. |
| ownerName | string | The name of the owner of the podcast. |
| ownerEmail | string | The email address of the owner. |
| thumbnailUrl | string | The URL to the thumbnail image for the podcast. |
| thumbnailPath | string | The path to the thumbnail image for the podcast. |
| canEmbed | bool | Indicates if the podcast can be embedded. |
| copyright | string | Copyright information for the podcast. |
| languageId | integer | The ID representing the language of the podcast. |
| explicitOptionId | integer | The ID indicating if the podcast has explicit material. |
| rssFeedUrl | string | The URL of the RSS feed for the podcast. |
| redirectUrl | string or null | The URL the podcast RSS feed permanently redirects to. Null when the redirect is cleared. |
| explicitOption | object | Details about the explicit podcast option. |
| id | integer | The ID of the explicit option. |
| name | string | The name of the explicit option. |
| value | string | The value of the explicit option. |
| categories | array[object] | A list of categories associated with the podcast |
| id | integer | The ID of the category. |
| name | string | The name of the category. |
| subcategories | array[object] | A list of subcategories within a category. |
| name | string | The name of the subcategory. |
| id | integer | The ID of the subcategory. |
| resultInfo | object | Additional information about the result |
| statusCode | integer | The 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