POST a Playlist
Overview
The following table contains important information about the POST
method in regards to posting a playlist.
POST Playlist | |
---|---|
Method | POST |
URL or Endpoint | /api/projects/projectId /playlists |
Headers | Authorization |
Parameters | projectId, api-version |
Body | Check request body below. |
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
{
"playlistTypeId": 0,
"title": "string"
}
Information about the fields that appear in the request body are displayed in the table below.
Parameter Name | Type | Description |
---|---|---|
playListTypeId | integer($int32) | Id of the playlist type. |
title | string | Title of the playlist. |
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
{
"publicId": "string",
"title": "string",
"description": "string",
"playListPagePermalink": "string",
"playListTypeId": 0,
"playlistDisplayTypeId": 0,
"playlistSortOptionId": 0,
"includeTags": [
"string"
],
"excludeTags": [
"string"
],
"includeTagsState": true,
"excludeTagsState": true,
"folders": [
0
],
"excludeFlags": [
0
],
"includeFlags": [
0
],
"includeAllProjects": true,
"includeProjects": [
"string"
],
"excludeFlagsState": true,
"includeFlagsState": true,
"includeTagModeId": 0,
"excludeTagModeId": 0,
"includeFlagModeId": 0,
"excludeFlagModeId": 0,
"maxVideos": 0,
"dateFrom": "2025-09-25T08:58:34.906Z",
"dateTo": "2025-09-25T08:58:34.906Z",
"canEmbed": true,
"playlistBackupState": true,
"playlistBackupId": "string",
"excludeWatchedVideosState": true,
"excludeKeywords": [
"string"
],
"aspectRatios": [
0
],
"includeTagMode": {
"id": 0,
"name": "string"
},
"excludeTagMode": {
"id": 0,
"name": "string"
},
"playlistType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string"
},
"playlistSortOption": {
"id": 0,
"name": "string"
},
"playlistDisplayType": {
"id": "string",
"name": "string",
"value": "string"
}
}
},
"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. |
publicId | string | The id of the playlist. |
title | string | The title of the playlist. |
description | string | Returns information about the playlist. |
playListPagePermalink | integer($int32) | The permalink of the playlist page. |
playListTypeId | integer($int32) | The id of the playlist type. |
playlistDisplayTypeId | integer($int32) | The id of the playlist display type. |
playlistSortOptionId | integer($int32) | The id of the playlist sorting option. |
includeTags | array[string] | An array that contains the tags you want to include in the playlist. |
excludeTags | array[string] | An array that contains the tags you want to exclude in the playlist. |
includeTagsState | bool | Indicates whether the tags state is included. |
excludeTagsState | bool | Indicates whether the tags state is excluded. |
folders | array[integer($int32)] | An array of folders whose videos should be included in the playlist. |
excludeFlags | array[integer($int32)] | An array that contains the flags you want to exclude in the playlist. |
includeFlags | array[integer($int32)] | An array that contains the flags you want to include in the playlist. |
includeAllProjects | bool | Indicates whether videos from all projects of organization should be included. |
includeProjects | array[string] | An array of project Ids whose videos should be included in the playlist. |
includeFlagsState | bool | Indicates whether the flags state is included. |
excludeFlagsState | bool | Indicates whether the flags state is excluded. |
includeTagModeId | integer($int32) | The id of the includeTag mode. |
excludeTagModeId | integer($int32) | The id of the excludeTag mode. |
includeFlagModeId | integer($int32) | The id of the includeFlag mode. |
excludeFlagModeId | integer($int32) | The id of the excludeFlag mode. |
maxVideos | integer($int32) | The number of maximum videos in the playlist. |
dateTimeFrom | string (ISO 8601 datetime) | Include videos uploaded on or after this datetime. |
dateTimeTo | string (ISO 8601 datetime) | Include videos uploaded on or before this datetime. |
canEmbed | bool | A boolean that indicates whether the playlist can be embedded or not. |
playlistBackupState | bool | A boolean that indicates whether the playlist has a backup playlist or not. |
playlistBackupId | integer($int32) | The unique identifier of the backup playlist. |
excludeWatchedVideosState | bool | A boolean that indicates whether the videos previously watched by the user should be included in the playlist or not. |
excludeKeywords | array[string] | An array of keywords; videos containing any of these keywords will be excluded from the playlist. |
aspectRatios | array[integer($int32)] | An array of aspect ratios; only videos that match the specified aspect ratios will be included in the playlist. |
includeTagMode | array[Object] | Returns the includeTag mode as an array of objects. |
id | string | The Id of the tag mode. |
name | string | The name of the tag mode. |
excludeTagMode | array[Object] | Returns the excludeTag mode as an array of objects. |
id | integer($int32) | The Id of the tag mode. |
name | string | The name of the tag mode. |
playlistType | array[Object] | Returns the playlist type as an array of objects. |
id | integer($int32) | The Id of the playlist type. |
name | string | The name of the playlist type. |
value | string | The value of the playlist type. |
description | string | The description of the playlist type. |
playlistSortOption | array[Object] | Returns the palylist sort option as ana array of objects. |
id | integer($int32) | The Id of the playlist sort option. |
name | string | The name of the playlist sort option. |
playlistDisplayType | array[Object] | Returns the playlist display type as an array of objects. |
id | integer($int32) | The Id of the playlist display type. |
name | string | The name of the playlist display type. |
value | string | The value of the playlist display type. |
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