Stop Quick Present

POST

/api/v1/presentation-overrides/{id}/stop

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

Requires an authenticated dashboard user.

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

reason

Defaults to “Stopped from Studio” when empty.

string

<= 500 characters

Example^generated

{
  "reason": "example"
}

Responses

200

Quick Present stopped

Media typeapplication/json

object

data

required

Active Quick Present session. The stopped timestamp and reason appear once the session ends.

object

id

required

string format: uuid

targetType

required

string

Allowed values: screen group

targetId

required

string format: uuid

targetName

required

string

contentType

required

string

Allowed values: playlist layout asset

contentId

required

string format: uuid

contentName

required

string

durationSeconds

required

integer

startedAt

required

string format: date-time

expiresAt

string format: date-time

afterAction

required

string

Allowed values: resume

wakeDisplay

required

boolean

stoppedAt

string format: date-time

stopReason

string

Example

{
  "data": {
    "targetType": "screen",
    "contentType": "playlist",
    "afterAction": "resume"
  }
}

401

Dashboard authentication required

404

Quick Present is no longer active