Skip to content
Tilecast Docs

createScreenGroup

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

Create a Display Group, optionally with its first members, in one transaction. Requires screen.manage. A caller with restricted screen access must name at least one screen, and every named screen and its current group peers must be within its access: an empty group has no anchor and would be unreachable to it (403 out_of_scope).

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
X-CSRF-Token
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters
description
string
screenIds

First members. Required, and at least one, for a caller with restricted screen access.

Array<string>
presentationGatewayScreenId

Ignored on creation. Set it with an update.

string | null format: uuid
clearPresentationGateway

Ignored on creation.

boolean
Examplegenerated
{
  "name": "example",
  "description": "example",
  "screenIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "presentationGatewayScreenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clearPresentationGateway": true
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Display Group created in Mirror mode

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

422

Section titled “422”

Validation or configured limit failed