PUT Podcast

Overview

---

The following table contains information about the PUT method for managing the process of updating a specific podcast.

PUT Podcast
Method	PUT
URL or Endpoint	/api/projects/projectId/podcasts
Headers	Authorization
Parameters	projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request Body

{
  "publicId": "string",
  "title": "string",
  "description": "string",
  "link": "string",
  "author": "string",
  "ownerName": "string",
  "ownerEmail": "string",
  "thumbnailUrl": "string",
  "thumbnailPath": "string",
  "copyright": "string",
  "languageId": 0,
  "explicitOptionId": 0,
  "categories": [
    {
      "id": 0,
      "name": "string",
      "subcategories": [
        {
          "name": "string",
          "id": 0
        }
      ]
    }
  ]
}

Information about the fields that appear on the request body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
publicId	Yes	string	Unique identifier of the podcast
title	Yes	string	Title of the podcast
description	No	string	Description of the podcast
link	No	string	Link to the podcast
author	No	string	Author of the podcast
ownerName	No	string	Name of the owner
ownerEmail	No	string	Email of the owner
thumbnailUrl	No	string	URL of the thumbnail
thumbnailPath	No	string	Path to the thumbnail
copyright	No	string	Copyright information
languageId	No	integer	Language ID
explicitOptionId	No	integer	Explicit content option ID
categories	No	array[Object]	Categories of the podcast
id	No	integer	ID of the category
name	No	string	Name of the category
subcategories	No	array[Object]	Subcategories of the category
name	No	string	Name of the subcategory
id	No	integer	ID of the subcategory

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{podcastId}",
    "title": "{title}",
    "description": "{description}",
    "link": "{link}",
    "author": "{author}",
    "ownerName": "{name}",
    "ownerEmail": "test@email.com",
    "thumbnailUrl": "",
    "thumbnailPath": "",
    "canEmbed": true,
    "copyright": "@test",
    "languageId": 1,
    "explicitOptionId": 1,
    "rssFeedUrl": "https://host.vpplayer.tech/{projectId}/podcast/{podcastId}/rss",
    "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 back-end
result	Object	Returns the response object
publicId	string	Unique identifier of the podcast
title	string	Title of the podcast
description	string	Description of the podcast
link	string	Link to the podcast
author	string	Author of the podcast
ownerName	string	Name of the owner
ownerEmail	string	Email of the owner
thumbnailUrl	string	URL of the thumbnail
thumbnailPath	string	Path to the thumbnail
canEmbed	bool	Indicates if the podcast can be embedded
copyright	string	Copyright information
languageId	integer	Language ID
explicitOptionId	integer	Explicit content option ID
rssFeedUrl	string	URL of the RSS feed
explicitOption	Object	Explicit content option details
id	integer	ID of the explicit content option
name	string	Name of the explicit content option
value	string	Value of the explicit content option
categories	array[Object]	Categories of the podcast
id	integer	ID of the category
name	string	Name of the category
subcategories	array[Object]	Subcategories of the category
id	integer	ID of the subcategory
name	string	Name of the subcategory
resultInfo	string	Returns extra information about the result
statusCode	integer	Returns the HTTP Status Code

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