widget

Edit a Widget

Changed on

Edit a widget providing new properties to set on it

put/playlist/widget/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/playlist/widget/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the Widget

Request body application/x-www-form-urlencoded

useDurationinteger

Set a duration on this widget, if unchecked the default or library duration will be used.

durationinteger

Duration to use on this widget

namestring

An optional name for this widget

enableStatstring

Should stats be enabled? On|Off|Inherit

isRepeatDatainteger

If this widget requires data, should that data be repeated to meet the number of items requested?

showFallbackstring

If this widget requires data and allows fallback data how should that data be returned? (never, always, empty, error)

propertiesinteger

Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed

Response

successful operation

Changes