POST a Video to a Playlist
Overview
The following table contains important information about the POST method in regards to posting a video to a playlist.
| POST Video to Playlist | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/playlists/videos |
| Headers | Authorization |
| Parameters | projectId |
| Body | playlistTypeId, videoId, position |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
{
"playlistId": "string",
"videoId": "string",
"position": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| playlistId | string | Unique ID of the playlist |
| videoId | string | Unique ID of the video. |
| position | integer($int32) | Position the video will be added in. |
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"playlistId": "string",
"videoId": "string",
"position": 0
},
"resultInfo": "string",
"statusCode": 0
}
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 will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| playlistId | string | Unique ID of the playlist |
| videoId | string | Unique ID of the video. |
| position | integer($int32) | Position the video will be added in. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | 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