approvePairing

POST

/api/v1/screens/pairing/{id}/approve

curl --request POST \
  --url https://example.com/api/v1/screens/pairing/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approve \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "roomName": "example", "roomNumber": "example", "description": "example", "replaceExistingCredential": false, "replaceHardware": false, "replacementScreenId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

name

required

string

>= 2 characters <= 120 characters

locationId

string | null format: uuid

roomName

required

string

<= 120 characters

roomNumber

required

string

<= 80 characters

description

required

string

<= 1000 characters

replaceExistingCredential

Explicitly authorizes credential rotation after successful enrollment.

boolean

replaceHardware

Assigns the new player to an existing logical screen without changing its content or policy relationships.

boolean

replacementScreenId

Required when replaceHardware is true.

string | null format: uuid

Responses

200

Screen approved

409

Pairing recovery confirmation required, hardware replacement conflict, or pairing state conflict