---
title: "Parameters for edting/adding audio file to a specific widget"
method: PUT
path: "/playlist/widget/{widgetId}/audio"
tags: ["widget"]
---

# Parameters for edting/adding audio file to a specific widget

`PUT /playlist/widget/{widgetId}/audio`

Parameters for edting/adding audio file to a specific widget

## Path parameters

- `widgetId` integer, required

## Response `200`

successful operation

- Widget — Class Widget
  - `widgetId` integer — The Widget ID
  - `playlistId` integer — The ID of the Playlist this Widget belongs to
  - `ownerId` integer — The ID of the User that owns this Widget
  - `type` string — The Module Type Code
  - `duration` integer — The duration in seconds this widget should be shown
  - `displayOrder` integer — The display order of this widget
  - `useDuration` integer — Flag indicating if this widget has a duration that should be used
  - `calculatedDuration` integer — Calculated Duration of this widget after taking into account the useDuration flag
  - `createdDt` string — The datetime the Layout was created
  - `modifiedDt` string — The datetime the Layout was last modified
  - `fromDt` integer — Widget From Date
  - `toDt` integer — Widget To Date
  - `schemaVersion` integer — Widget Schema Version
  - `transitionIn` integer — Transition Type In
  - `transitionOut` integer — Transition Type out
  - `transitionDurationIn` integer — Transition duration in
  - `transitionDurationOut` integer — Transition duration out
  - `widgetOptions` WidgetOption[] — An array of Widget Options
    - `widgetId` integer — The Widget ID that this Option belongs to
    - `type` string — The option type, either attrib or raw
    - `option` string — The option name
    - `value` string — The option value
  - `mediaIds` integer[] — An array of MediaIds this widget is linked to
  - `audio` WidgetAudio[] — An array of Audio MediaIds this widget is linked to
    - `widgetId` integer — The Widget Id
    - `mediaId` integer — The Media Id
    - `volume` integer — The percentage volume
    - `loop` integer — Flag indicating whether to loop
  - `permissions` Permission[] — An array of permissions for this widget
    - `permissionId` integer — The ID of this Permission Record
    - `entityId` integer — The Entity ID that this Permission refers to
    - `groupId` integer — The User Group ID that this permission refers to
    - `objectId` integer — The object ID that this permission refers to
    - `isUser` integer — A flag indicating whether the groupId refers to a user specific group
    - `entity` string — The entity name that this refers to
    - `objectIdString` string — Legacy for when the Object ID is a string
    - `group` string — The group name that this refers to
    - `view` integer — A flag indicating whether view permission is granted
    - `edit` integer — A flag indicating whether edit permission is granted
    - `delete` integer — A flag indicating whether delete permission is granted
    - `modifyPermissions` integer — A flag indicating whether modify permission permission is granted.
  - `playlist` string — The name of the Playlist this Widget is on

---

[API](https://skmtc.net/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.net/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/versions/fe497e811c7f/schema)