Skip to main content
POST
Creates a new screen

Authorizations

Authorization
string
header
required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

This key is used for all APIs with the exception of ingest.

Body

application/json

Request body.

title
string
required

The title of this screen.

ratio
enum<string>
required

The width to height aspect ratio of this screen.

Available options:
3:2,
4:3,
5:4,
16:9,
16:10,
21:9
rotate90Degrees
boolean
required

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

background
enum<string>
required

The background color to use when viewing the screen.

Available options:
dark,
light
categories
string[]

A list of string categories the screen belongs to.

widgets
object[]

Response

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

id
string
required
read-only

The identifier of this screen.

title
string
required

The title of this screen.

ratio
enum<string>
required

The width to height aspect ratio of this screen.

Available options:
3:2,
4:3,
5:4,
16:9,
16:10,
21:9
rotate90Degrees
boolean
required

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

background
enum<string>
required

The background color to use when viewing the screen.

Available options:
dark,
light
account
string
read-only

The account this screen belongs to.

categories
string[]

A list of string categories the screen belongs to.

widgets
object[]