Skip to main content

POST Audio to Podcast

Overview


The following table contains important information about the POST method for managing the process of uploading an audio into a specific podcast.

POST Audio to Podcast
MethodPOST
URL or Endpoint/api/v1​/projectId​/podcasts/audios
ParametersprojectId
BodyCheck the body below

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.

Request Body

{
"podcastId": "string",
"audioId": "string",
"position": 0
}

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

Parameter NameMandatoryTypeDescription
podcastIdYesstringThe unique identifier for the podcast.
audioIdYesstringThe unique identifier for the audio file.
positionNointegerThe position of the audio in the podcast.

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"podcastId": "{podcastId}",
"audioId": "{audioId}",
"position": 0
},
"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.
podcastIdstringThe unique identifier for the podcast.
audioIdstringThe unique identifier for the audio file.
positionintegerThe position of the audio in the podcast
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