screens

Pair a device by its code

Pair a device using its 6-digit pairing code, creating a new screen. Provide code, name, and an optional nodeId. This endpoint is rate-limited because the pairing code space is small, and is refused if your account is suspended or cancelled.

Claims the device showing a 6-digit pairing code into this workspace as a new screen.

post/v1/screens/claim

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/screens/claim
  • Auth: HTTP bearer

Request body

codestring required

The 6-digit code the device shows.

namestring

Screen name. Default "New screen".

nodeIdstring

Location to file the screen under.

billingGroupIdstring

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.