renewScreenPreview

POST

/api/v1/screens/{id}/preview-session

curl --request POST \
  --url https://example.com/api/v1/screens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview-session \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "forceCapture": true }'

Renew a screen preview session, optionally forcing a fresh capture. Requires an enrolled dashboard session. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

forceCapture

boolean

Example^generated

{
  "forceCapture": true
}

Responses

200

Preview session renewed

Media typeapplication/json

object

data

required

object

active

required

boolean

expiresAt

string format: date-time

captureIntervalSeconds

required

integer

captureNow

required

boolean

Example^generated

{
  "data": {
    "active": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "captureIntervalSeconds": 1,
    "captureNow": true
  }
}

400

Invalid request body

401

Dashboard authentication required