Skip to content
Tilecast Docs

updateScreenGroup

PATCH
/api/v1/screen-groups/{id}
curl --request PATCH \
  --url https://example.com/api/v1/screen-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "presentationGatewayScreenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "clearPresentationGateway": true }'

Update screen group. Requires an authenticated dashboard user.

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
required
string
>= 1 characters
description
string
presentationGatewayScreenId
string | null format: uuid
clearPresentationGateway
boolean
Examplegenerated
{
  "name": "example",
  "description": "example",
  "presentationGatewayScreenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clearPresentationGateway": true
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Display Group updated

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
name
required
string
description
required
string
displayMode
required
string
Allowed values: mirror span
presentationGatewayScreenId
string format: uuid
playlistId
string format: uuid
playlistName
string
layoutId
string format: uuid
layoutName
string
presentationType
string
Allowed values: playlist layout
playbackEpoch
required
string format: date-time
membershipCount
required
integer
screens
required
Array<object>
object
id
required
string format: uuid
name
required
string
location
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "data": {
    "displayMode": "mirror",
    "presentationType": "playlist"
  }
}