Sign in
latestOpenAPI 3.1.02026-07-26189891.1 MB

fb2535545d90

Screens

Creates a new screen

Creates a new screen

post/v1/config/screen

Request body

idstring required

The identifier of this screen.

accountstring

The account this screen belongs to.

titlestring required

The title of this screen.

ratio'3:2' | '4:3' | '5:4' | '16:9' | '16:10' | '21:9' required

The width to height aspect ratio of this screen.

rotate90Degreesboolean required

Whether the screen is rotated 90 degrees. Setting to true effectively swaps the width to height ratio.

background'dark' | 'light' required

The background color to use when viewing the screen.

categoriesstring[]

A list of string categories the screen belongs to.

Response

A new screen was created successfully! Entire memberResource is returned.

idstring required

The identifier of this screen.

accountstring

The account this screen belongs to.

titlestring required

The title of this screen.

ratio'3:2' | '4:3' | '5:4' | '16:9' | '16:10' | '21:9' required

The width to height aspect ratio of this screen.

rotate90Degreesboolean required

Whether the screen is rotated 90 degrees. Setting to true effectively swaps the width to height ratio.

background'dark' | 'light' required

The background color to use when viewing the screen.

categoriesstring[]

A list of string categories the screen belongs to.