---
title: Tagged Playlists Entity (2022/06)
slug: develop/tagged-playlists-entity-202206
docTags: 
createdAt: 2025-03-11T07:03:30.743Z
---

All Tagged Playlist entities are structured as follows:

`entity`:

- `Id` <font color="#704ae0">int</font> <font color="#01a0af">read-only</font>: A unique identifier for the tagged playlist instance. This value is generated by the server when the tagged playlist is created.
- `Name` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The name of the tagged playlist. The maximum length of this string is 50 characters.
- `PhysicalPath` <font color="#704ae0">string</font> <font color="#01a0af">read-only</font>: The location of the file in the server directory
- `ContentsVirtualPath` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The virtual directory location of files in the tagged playlist. Tagged playlists can only use files contained in this directory.
- `Rule` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: A set of tagging conditions that determines tagged media to include in the playlist.&#x20;
- `TTL` <font color="#704ae0">TimeSpan</font> <font color="#01a0af">read-write</font>: The frequency with which players will query BSN.Cloud servers to determine if there is any new tagged media to include/exclude in the tagged playlist (TTL is an acronym for time to live). See [TimeSpan](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `WaitingForApprove` <font color="#704ae0">bool</font> <font color="#01a0af">read-write</font>: A flag that determines whether recent changes to media tags have been approved for the tagged playlist. By default, changing media tags will not automatically add or remove media from a tagged playlist. A user with the "Update Tagged Playlist" permission (Administrators, Creators, General Managers) will need to set this flag to `false` for changes to go into effect.&#x20;
- `CreationDate` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: A timestamp indicating when the tagged playlist was created on BSN.Cloud. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `LastModifiedDate` <font color="#704ae0">DateTime</font> <font color="#01a0af">read-only</font>: A timestamp indicating when the tagged playlist was last modified on BSN.Cloud. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
- `Content` <font color="#704ae0">TaggedPlaylistContent[]</font> <font color="#01a0af">read-write</font>: An array of content object instances representing content files in the tagged playlist:
  - `ContentId` <font color="#704ae0">int</font> <font color="#01a0af">read-write</font>: The unique identifier for the tagged playlist content
  - `FileName` <font color="#704ae0">string</font> <font color="#01a0af">read-write</font>: The filename of the tagged playlist content&#x20;
  - `DisplayDuration` <font color="#704ae0">Nullable&lt;TimeSpan&gt;</font> <font color="#01a0af">read-write</font>: The amount of time the content will be displayed before transitioning to the next entry (the default is six seconds). See [TimeSpan](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
  - `ValidityStartDate` <font color="#704ae0">Nullable&lt;DateTime&gt;</font> <font color="#01a0af">read-write</font>: The validity start date for the entry (that is, the point at which it will start being included in the tagged playlist). A null value specifies that the item is valid immediately when added to the tagged playlist. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
  - `ValidityEndDate` <font color="#704ae0">Nullable&lt;DateTime&gt;</font> <font color="#01a0af">read-write</font>: The validity end date for the associated entry (that is, the point at which it will no longer be included in the tagged playlist). A null value specifies that the item will be valid until it is removed from the tagged playlist manually. See [DateTime](docId\:dX1C8uSfkXPwntpRb9f-T) for more information about this data type.
  - `State` <font color="#704ae0">TaggedPlaylistContentState</font> <font color="#01a0af">read-write</font>: The content state enumeration has three possible values: "Approved", "Pending Addition", and "Pending Deletion".
- `Presentations` <font color="#704ae0">PresentationInfo[]</font> <font color="#01a0af">read-only</font>: An array of [Presentation Info](docId\:rH_TKLzOo3RPBID0mDC9v) entities for each presentation associated with the tagged playlist instance
- `Permissions` <font color="#704ae0">Permission[]</font> <font color="#01a0af">read-write</font>: A list of permission object instances representing permissions rules assigned to the tagged playlist