Activate a Takeover

POST

/api/v1/takeovers

curl --request POST \
  --url https://example.com/api/v1/takeovers \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "name": "example", "description": "example", "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "screenIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "groupIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "expiresAt": "2026-04-15T12:00:00Z", "password": "example" }'

Requires an authenticated dashboard user. Activating a takeover is immediate and disruptive; when the organization requires reauthentication, the current account password travels in the body and a wrong one answers 401.

Authorizations

• sessionCookie
• userBearer

Parameters

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

name

required

string

>= 1 characters <= 180 characters

description

string

<= 2000 characters

playlistId

required

string format: uuid

screenIds

Array<string>

groupIds

Array<string>

expiresAt

required

string format: date-time

password

Current account password, only when the organization requires reauthentication for takeovers.

string

Example^generated

{
  "name": "example",
  "description": "example",
  "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "screenIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "groupIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "expiresAt": "2026-04-15T12:00:00Z",
  "password": "example"
}

Responses

201

Takeover activated

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

status

required

string

Allowed values: active

affectedCount

required

integer

expiresAt

required

string format: date-time

Example

{
  "data": {
    "status": "active"
  }
}

401

Dashboard authentication required

422

Invalid targets, playlist, or expiration