Skip to main content
POST
POST /screens
Required permissions: screens.create. Send an Idempotency-Key for this change. It is an operation ID, not an API key. Generate a UUID and reuse it when retrying the same request.
Use your Platform API key in Postman or your backend. Keep it private; do not enter it in this public page. Your workspace permissions and plan limits apply.
See the quickstart for request examples. Required fields and responses are listed below.

Authorizations

Authorization
string
header
required

Platform API key for one workspace. Create it in Settings with an expiry date or Never expire. Keep it private; use it from Postman or your backend, not browser code. Widget keys are not accepted.

Headers

Idempotency-Key
string
required

An operation ID, not your API key. Generate a UUID for each new change and reuse it when retrying the same request. See https://docs.layarva.com/developers/platform-request-keys for Postman, PowerShell and Node.js examples. Upload instructions are refreshed when requested again.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Body

application/json

Send application/json using the fields below. JSON requests must be no larger than 64 KiB.

EDGE requires edgeDeviceId; other modes forbid it. OFFLINE requires channelId. All assignments must belong to workspace; quota and acceptsPlanScreen are enforced, not overridden by this flag.

name
string
required
Required string length: 1 - 255
channelId
string | null
Pattern: ^[A-Za-z0-9_-]{1,100}$
locationId
string | null
Pattern: ^[A-Za-z0-9_-]{1,100}$
clientId
string | null
Pattern: ^[A-Za-z0-9_-]{1,100}$
displayConfig
object
deliveryMode
enum<string>
default:CLOUD
Available options:
CLOUD,
EDGE,
OFFLINE
edgeDeviceId
string
Pattern: ^[A-Za-z0-9_-]{1,100}$
acceptsPlanScreen
boolean
default:false

Response

Safe live-authorized result

data
object
required

List/detail projection excludes clientId/unlockConfigured; mutation projection may include them. status is derived from current heartbeat, storedStatus is historical; paired has no device token.