Skip to main content

PUT a Playlist

Overview


The following table contains important information about the PUT method in regards to updating a playlist.

PUT Playlist
MethodPUT
URL or Endpoint/api/projects/projectId/playlists
HeadersAuthorization
ParametersprojectId, api-version
BodyCheck the request body below.

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdNostringUnique Id of the project.
api-versionNostringCorrect api-version.

Request Body

{
"publicId": "string",
"title": "string",
"description": "string",
"playListPagePermalink": "string",
"playListTypeId": 0,
"playlistSortOptionId": 0,
"includeTags": [
"string"
],
"excludeTags": [
"string"
],
"includeTagsState": true,
"excludeTagsState": true,
"folders": [
0
],
"excludeFlags": [
0
],
"includeFlags": [
0
],
"excludeFlagsState": true,
"includeFlagsState": true,
"includeTagModeId": 0,
"excludeTagModeId": 0,
"maxVideos": 0,
"canEmbed": true,
"includeTagMode": {
"id": 0,
"name": "string"
},
"excludeTagMode": {
"id": 0,
"name": "string"
},
"playlistType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string"
},
"playlistSortOption": {
"id": 0,
"name": "string"
}
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
publicIdstringThe id of the playlist.
titlestringThe title of the playlist.
descriptionstringReturns information about the playlist.
playListPagePermalinkinteger($int32)The permalink of the playlist page.
playListTypeIdinteger($int32)The id of the playlist type.
playlistSortOptionIdinteger($int32)The id of the playlist sorting option.
includeTagsarray[string]An array that contains the tags you want to include in the playlist.
excludeTagsarray[string]An array that contains the tags you want to exclude in the playlist.
includeTagsStateboolIndicates whether the tags state is included.
excludeTagsStateboolIndicates whether the tags state is excluded.
includeFlagsarray[string]An array that contains the flags you want to include in the playlist.
excludeFlagsarray[string]An array that contains the flags you want to exclude in the playlist.
includeFlagsStateboolIndicates whether the flags state is included.
excludeFlagsStateboolIndicates whether the flags state is excluded.
includeTagModeIdinteger($int32)The id of the includeTag mode.
excludeTagModeIdinteger($int32)The id of the excludeTag mode.
maxVideosinteger($int32)The number of maximum videos in the playlist.
canEmbedboolA boolean that indicates whether the playlist can be embedded or not.
includeTagModearray[Object]Returns the includeTag mode as an array of objects.
idstringThe Id of the tag mode.
namestringThe name of the tag mode.
excludeTagModearray[Object]Returns the excludeTag mode as an array of objects.
idinteger($int32)The Id of the tag mode.
namestringThe name of the tag mode.
playlistTypearray[Object]Returns the playlist type as an array of objects.
idinteger($int32)The Id of the playlist type.
namestringThe name of the playlist type.
valuestringThe value of the playlist type.
descriptionstringThe description of the playlist type.
playlistSortOptionarray[Object]Returns the palylist sort option as ana array of objects.
idinteger($int32)The Id of the playlist sort option.
namestringThe name of the playlist sort option.

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"publicId": "string",
"title": "string",
"description": "string",
"playListPagePermalink": "string",
"playListTypeId": 0,
"playlistSortOptionId": 0,
"includeTags": [
"string"
],
"excludeTags": [
"string"
],
"includeTagsState": true,
"excludeTagsState": true,
"folders": [
0
],
"excludeFlags": [
0
],
"includeFlags": [
0
],
"excludeFlagsState": true,
"includeFlagsState": true,
"includeTagModeId": 0,
"excludeTagModeId": 0,
"maxVideos": 0,
"canEmbed": true,
"includeTagMode": {
"id": 0,
"name": "string"
},
"excludeTagMode": {
"id": 0,
"name": "string"
},
"playlistType": {
"id": 0,
"name": "string",
"value": "string",
"description": "string"
},
"playlistSortOption": {
"id": 0,
"name": "string"
}
},
"resultInfo": "string",
"statusCode": 0
}

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 will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
publicIdstringThe id of the playlist.
titlestringThe title of the playlist.
descriptionstringReturns information about the playlist.
playListPagePermalinkinteger($int32)The permalink of the playlist page.
playListTypeIdinteger($int32)The id of the playlist type.
playlistSortOptionIdinteger($int32)The id of the playlist sorting option.
includeTagsarray[string]An array that contains the tags you want to include in the playlist.
excludeTagsarray[string]An array that contains the tags you want to exclude in the playlist.
includeTagsStateboolIndicates whether the tags state is included.
excludeTagsStateboolIndicates whether the tags state is excluded.
includeFlagsarray[string]An array that contains the flags you want to include in the playlist.
excludeFlagsarray[string]An array that contains the flags you want to exclude in the playlist.
includeFlagsStateboolIndicates whether the flags state is included.
excludeFlagsStateboolIndicates whether the flags state is excluded.
includeTagModeIdinteger($int32)The id of the includeTag mode.
excludeTagModeIdinteger($int32)The id of the excludeTag mode.
maxVideosinteger($int32)The number of maximum videos in the playlist.
canEmbedboolA boolean that indicates whether the playlist can be embedded or not.
includeTagModearray[Object]Returns the includeTag mode as an array of objects.
idstringThe Id of the tag mode.
namestringThe name of the tag mode.
excludeTagModearray[Object]Returns the excludeTag mode as an array of objects.
idinteger($int32)The Id of the tag mode.
namestringThe name of the tag mode.
playlistTypearray[Object]Returns the playlist type as an array of objects.
idinteger($int32)The Id of the playlist type.
namestringThe name of the playlist type.
valuestringThe value of the playlist type.
descriptionstringThe description of the playlist type.
playlistSortOptionarray[Object]Returns the palylist sort option as ana array of objects.
idinteger($int32)The Id of the playlist sort option.
namestringThe name of the playlist sort option.
resultInfostringReturns extra information about the result.
statusCodeinteger($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