quick-posts

Post a quick message to screens

Make a full-screen message from a headline and an optional body, then cast it to the chosen screens until it expires. The scope is checked first: when it reaches no screen you can cast to, nothing is created. The cast is listed in GET /v1/casts with the headline as its contentName; send its castId to POST /v1/casts/{id}/clear to take the message off every screen. Needs creative.create as well as screen.cast.

Makes a full-screen template from a headline and an optional body, then casts it to the chosen screens until it expires. The scope is checked first: when it reaches no screen, nothing is made.

Notes.

  • Needs creative.create as well as screen.cast.
post/v1/quick-posts

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/quick-posts
  • Auth: HTTP bearer

Request body

headlinestring required

The large line. Cut to 120 characters.

bodystring

A smaller line under the headline. Cut to 400 characters.

tone'announcement' | 'alert' | 'celebrate' | 'info'

The background color. Default announcement.

scopeKind'all' | 'node' | 'screens'

Which screens. Default all (every screen the caller can cast to).

scopeNodeIdstring

With scopeKind node: the location. Its sub-locations are included.

screenIdsstring[]

With scopeKind screens: the screens.

expiresInSecinteger

How long it stays on the screens, in seconds. Default 3600.

Response

Success.

Changes

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