banners

Create a banner

Create an announcement banner with a title and optional body, tone, audience, and active state. tone defaults to "info" when not specified.

Notes.

  • The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column.
post/v1/banners

Request

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

Request body

titlestring required
bodystring nullable
tone'info' | 'success' | 'warning' | 'critical'

Default info.

audienceobject
activeboolean

Default true.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.