Skip to content
Tilecast Docs

updateScreen

PATCH
/api/v1/screens/{id}
curl --request PATCH \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "name": "example", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roomName": "example", "roomNumber": "example", "mapPositionOverride": { "latitude": 1, "longitude": 1 }, "description": "example" }'

Requires the Owner or Administrator role with the write scope. Cookie requests additionally require the X-CSRF-Token header. Replaces a screen’s details document.

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
name
string
>= 2 characters <= 120 characters
locationId
string | null format: uuid
roomName
string
<= 120 characters
roomNumber
string
<= 80 characters
mapPositionOverride
One of:
object
latitude
required
number
>= -90 <= 90
longitude
required
number
>= -180 <= 180
description
string
<= 1000 characters
Examplegenerated
{
  "name": "example",
  "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "roomName": "example",
  "roomNumber": "example",
  "mapPositionOverride": {
    "latitude": 1,
    "longitude": 1
  },
  "description": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Screen updated

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
description
required
string
location
required
string
locationId
string format: uuid
locationDetails
object
id
required
string format: uuid
name
required
string
addressLine1
required
string
addressLine2
required
string
city
required
string
state
required
string
postalCode
required
string
country
required
string
latitude
number
longitude
number
screenCount
required
integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
roomName
required
string
roomNumber
required
string
mapPositionOverride
object
latitude
required
number
>= -90 <= 90
longitude
required
number
>= -180 <= 180
mapPosition
object
latitude
required
number
>= -90 <= 90
longitude
required
number
>= -180 <= 180
source
required
string
Allowed values: screen location
syncGroupId
string format: uuid
syncGroupName
string
nowPlayingName
string
nowPlayingType
string
platform
required
string
deviceManufacturer
required
string
deviceModel
required
string
androidVersion
required
string
playerVersion
required
string
playerVersionCode
integer format: int64
androidSdk
integer
installerSource
string
installPermissionStatus
string
currentUpdateDeploymentId
string format: uuid
updateState
string
updateDownloadedBytes
integer format: int64
updateExpectedBytes
integer format: int64
updateError
string
playerFamily
string
playerArchitecture
string
screenWidth
required
integer
screenHeight
required
integer
density
required
number format: float
locale
required
string
timezone
required
string
availableStorageBytes
integer format: int64
uptimeSeconds
integer format: int64
enabled
required
boolean
pairedAt
required
string format: date-time
lastConnectedAt
string format: date-time
lastDisconnectedAt
string format: date-time
lastHeartbeatAt
string format: date-time
lastKnownIp
string
lastContactAt
string format: date-time
status
required

The Server-computed Screen status. awaiting_player is a Browser Player Screen whose managed launch link has not been used yet. The set grows with new Player kinds; clients must tolerate values they do not recognize.

string
hasActiveCredential
required
boolean
archivedAt
string format: date-time
archivedReason
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "data": {
    "mapPosition": {
      "source": "screen"
    }
  }
}

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

Owner or Administrator required