Templates

Create a new module/zone within a template. Modules/zones define rectangular content areas where playlist content is displayed.

post/templates/{templateId}/modules

Request

Base URL
https://api.reveldigital.com
Auth
- OAuth 2
  Authorization codehttps://id.reveldigital.com/connect/authorize
  Token URLhttps://id.reveldigital.com/connect/token
  Scopeswebapi
- or API key in header X-RevelDigital-ApiKey
- or API key in query parameter api_key
TypeScript
https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/templates/:templateId/modules/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

templateIdstring required

Template Id

Request body

namestring nullable

Module/zone name (descriptive identifier)

typestring nullable

Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')

leftinteger nullable

Left position

topinteger nullable

Top position

widthinteger nullable

Width

heightinteger nullable

Height

playlist_idstring nullable

Playlist assigned to this module

sequenceinteger nullable

Sequence or Z-Order

Response

Returns the newly-created module/zone

idstring nullable

Module/zone unique identifier

namestring nullable

Module/zone name

typestring nullable

Module/zone type (e.g., 'Playlist', 'Clock', 'Weather', 'Ticker', 'Web')

leftinteger nullable

Left position in pixels from the top-left corner of the template

topinteger nullable

Top position in pixels from the top-left corner of the template

widthinteger nullable

Width of the module/zone in pixels

heightinteger nullable

Height of the module/zone in pixels

playlist_idstring nullable

Playlist ID assigned to this module/zone. Determines what content is displayed in this area of the screen.

sequenceinteger nullable

Sequence or Z-order for overlapping modules/zones. Higher values appear in front of lower values.

Changes

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