publishLayout

POST

/api/v1/layouts/{id}/publish

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

Publish layout. Requires an authenticated dashboard user. Publishes the draft the caller read first: the request carries the draft revision it saw, and a 409 means someone else published first. A layout under editorial review answers 202 with the submission instead of publishing.

Authorizations

• sessionCookie
• userBearer

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

expectedDraftRevision

required

integer

>= 1

Example^generated

{
  "expectedDraftRevision": 1
}

Responses

201

Immutable published revision created

Media typeapplication/json

object

data

required

One of:

object

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

object

object

id

required

string format: uuid

layoutId

required

string format: uuid

revision

required

integer format: int64

>= 1

document

required

object

schemaVersion

required

Only schema version 2 is accepted.

integer

Allowed values: 2

canvas

required

object

width

required

integer

>= 320 <= 7680

height

required

integer

>= 320 <= 7680

orientation

required

string

Allowed values: landscape portrait custom

backgroundColor

required

string

backgroundAssetId

string format: uuid

backgroundVariantId

string format: uuid

safeAreaPercent

required

number

<= 20

placements

required

Array<object>

<= 200 items

object

id

required

string format: uuid

type

required

string

Allowed values: widget asset playlistZone primitive

name

required

string

x

required

number

y

required

number

width

required

number

height

required

number

layer

required

integer

<= 999

opacity

required

number

<= 1

visible

required

boolean

locked

required

boolean

groupId

string format: uuid

widgetId

string format: uuid

assetId

string format: uuid

variantId

string format: uuid

playlistId

string format: uuid

overrides

Legacy Widget placement override bag. The listed values are accepted for saved-document compatibility but are ignored by Studio and Player.

object

fit

string

Allowed values: contain cover stretch

alignment

string

Allowed values: left center right

foregroundColor

string

backgroundColor

string

fallbackVisibility

string

Allowed values: show hide

muted

boolean

primitive

object

kind

required

string

Allowed values: text rectangle circle line group

text

string

<= 4000 characters

fontFamily

Only bundled fonts are accepted for text primitives

string

Allowed values: Inter Roboto Source Sans 3 Noto Sans

fontId

A family from the organization font library. fontFamily stays the bundled fallback

string format: uuid

fontSize

number

>= 8 <= 600

fontWeight

integer

Allowed values: 400 500 600 700 800

textAlign

string

Allowed values: left center right

verticalAlign

string

Allowed values: top center bottom

color

string

backgroundColor

string

lineHeight

number

letterSpacing

number

padding

number

borderWidth

number

borderColor

string

cornerRadius

number

maximumLines

integer

>= 1

overflow

string

Allowed values: clip ellipsis

autoFit

boolean

minimumFontSize

number

fillColor

string

strokeColor

string

strokeWidth

number

binding

object

dataSourceId

required

string format: uuid

field

required

string

>= 1 characters

prefix

string

<= 500 characters

suffix

string

<= 500 characters

fallbackText

string

<= 500 characters

hideWhenEmpty

boolean

format

string

Allowed values: text date-short date-long number integer currency

playback

object

fit

string

Allowed values: contain cover stretch

muted

boolean

loop

boolean

fallback

string

Allowed values: hide background previous

cornerRadius

number

<= 1000

documentSha256

required

string

publishedBy

string format: uuid

publishedAt

required

string format: date-time

Example

{
  "data": {
    "submission": {
      "contentType": "playlist",
      "status": "in_review"
    }
  }
}

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"
  }
}

409

Draft revision conflict