Skip to content
Tilecast Docs

publishPlaylist

POST
/api/v1/playlists/{id}/publish
curl --request POST \
  --url https://example.com/api/v1/playlists/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "expectedDraftRevision": 1 }'

Requires a content manager (Owner, Administrator, or Editor) with the write scope. Publishes the draft the CLI read first: the request carries the draft revision it saw, and a 409 means someone else published first. A playlist under editorial review answers 202 with the submission instead of publishing.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expectedDraftRevision
required
integer
>= 1
Examplegenerated
{
  "expectedDraftRevision": 1
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Playlist published

Media typeapplication/json
object
data
required

Exact submitted snapshot published and recorded in history. The published record carries untagged Go-cased keys from the editorial package.

object
submission
required
object
id
required
string format: uuid
contentType
required
string
Allowed values: playlist layout campaign
contentId
required
string format: uuid
contentName
string
workingRevision
required
integer format: int64
>= 1
snapshot
required
object
key
additional properties
any
snapshotSha256
required
string
/^[0-9a-f]{64}$/
submittedBy
string format: uuid
submitterName
string
submittedAt
required
string format: date-time
basedPublishedRevision
integer format: int64
basedPublishedRevisionId
string format: uuid
status
required
string
Allowed values: in_review changes_requested approved scheduled published superseded publication_failed
reviewRequired
required
boolean
allowSelfApproval
required
boolean
reviewNote
string
reviewedBy
string format: uuid
reviewerName
string
reviewedAt
string format: date-time
requestedPublicationAt
string format: date-time
publicationFailureReason
string
publishedAt
string format: date-time
newerWorkingDraft
required
boolean
currentPublishedRevision
integer format: int64
affectedScreenCount
required
integer
affectedLocationCount
required
integer
published
required

Native published record with untagged Go-cased keys.

object
key
additional properties
any
Example
{
  "data": {
    "submission": {
      "contentType": "playlist",
      "status": "in_review"
    }
  }
}

202

Section titled “202”

Submitted for editorial review instead of publishing

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
contentType
required
string
Allowed values: playlist layout campaign
contentId
required
string format: uuid
contentName
string
workingRevision
required
integer format: int64
>= 1
snapshot
required
object
key
additional properties
any
snapshotSha256
required
string
/^[0-9a-f]{64}$/
submittedBy
string format: uuid
submitterName
string
submittedAt
required
string format: date-time
basedPublishedRevision
integer format: int64
basedPublishedRevisionId
string format: uuid
status
required
string
Allowed values: in_review changes_requested approved scheduled published superseded publication_failed
reviewRequired
required
boolean
allowSelfApproval
required
boolean
reviewNote
string
reviewedBy
string format: uuid
reviewerName
string
reviewedAt
string format: date-time
requestedPublicationAt
string format: date-time
publicationFailureReason
string
publishedAt
string format: date-time
newerWorkingDraft
required
boolean
currentPublishedRevision
integer format: int64
affectedScreenCount
required
integer
affectedLocationCount
required
integer
Example
{
  "data": {
    "contentType": "playlist",
    "status": "in_review"
  }
}

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

A content manager is required

409

Section titled “409”

The draft moved since it was read; read it again