--- title: "Edit Layout" method: PUT path: "/layout/{layoutId}" tags: ["layout"] --- # Edit Layout `PUT /layout/{layoutId}` Edit a Layout ## Path parameters - `layoutId` integer, required ## Response `200` successful operation - Layout — Class Layout - `layoutId` integer — The layoutId - `ownerId` integer — The userId of the Layout Owner - `campaignId` integer — The id of the Layout's dedicated Campaign - `parentId` integer — The parentId, if this Layout has a draft - `publishedStatusId` integer — The Status Id - `publishedStatus` string — The Published Status (Published, Draft or Pending Approval - `publishedDate` string — The Published Date - `backgroundImageId` integer — The id of the image media set as the background - `schemaVersion` integer — The XLF schema version - `layout` string — The name of the Layout - `description` string — The description of the Layout - `backgroundColor` string — A HEX string representing the Layout background color - `createdDt` string — The datetime the Layout was created - `modifiedDt` string — The datetime the Layout was last modified - `status` integer — Flag indicating the Layout status - `retired` integer — Flag indicating whether the Layout is retired - `backgroundzIndex` integer — The Layer that the background should occupy - `width` number, double — The Layout Width - `height` number, double — The Layout Height - `orientation` string — The Layout Orientation - `displayOrder` integer — If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign - `duration` integer — A read-only estimate of this Layout's total duration in seconds. This is equal to the longest region duration and is valid when the layout status is 1 or 2. - `statusMessage` string — A status message detailing any errors with the layout - `enableStat` integer — Flag indicating whether the Layout stat is enabled - `autoApplyTransitions` integer — Flag indicating whether the default transitions should be applied to this Layout - `code` string — Code identifier for this Layout - `isLocked` boolean — Is this layout locked by another user? - `regions` Region[] — An array of Regions belonging to this Layout - `regionId` integer — The ID of this region - `layoutId` integer — The Layout ID this region belongs to - `ownerId` integer — The userId of the User that owns this Region - `type` string — Region Type, zone, playlist, frame or canvas - `name` string — The name of this Region - `width` number, double — Width of the region - `height` number, double — Height of the Region - `top` number, double — The top coordinate of the Region - `left` number, double — The left coordinate of the Region - `zIndex` integer — The z-index of the Region to control Layering - `syncKey` string — The syncKey of this Region - `regionOptions` RegionOption[] — An array of Region Options - `regionId` integer — The regionId that this Option applies to - `option` string — The option name - `value` string — The option value - `permissions` Permission[] — An array of Permissions - `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. - `duration` integer — A read-only estimate of this Regions's total duration in seconds. This is valid when the parent layout status is 1 or 2. - `isDrawer` integer — Flag, whether this region is used as an interactive drawer attached to a layout. - `regionPlaylist` Playlist — Class Playlist - `playlistId` integer — The ID of this Playlist - `ownerId` integer — The userId of the User that owns this Playlist - `name` string — The Name of the Playlist - `regionId` integer — The RegionId if this Playlist is specific to a Region - `isDynamic` integer — Flag indicating if this is a dynamic Playlist - `filterMediaName` string — Filter Name for a Dynamic Playlist - `filterMediaNameLogicalOperator` string — Which logical operator should be used when filtering by multiple Plalust names? OR|AND - `filterMediaTags` string — Filter Tags for a Dynamic Playlist - `filterExactTags` integer — Flag indicating whether to filter by exact Tag match - `filterMediaTagsLogicalOperator` string — Which logical operator should be used when filtering by multiple Tags? OR|AND - `filterFolderId` integer — The ID of the folder to filter media items by - `maxNumberOfItems` integer — Maximum number of Media items matching dynamic Playlist filters - `createdDt` string — The datetime this entity was created - `modifiedDt` string — The datetime this entity was last modified - `duration` integer — A read-only estimate of this Layout's total duration in seconds. This is equal to the longest region duration and is valid when the layout status is 1 or 2. - `requiresDurationUpdate` integer — Flag indicating whether this Playlists requires a duration update - `enableStat` string — The option to enable the collection of Playlist Proof of Play statistics - `tags` TagLink[] — Tags associated with this Playlist, array of TagLink objects - `tag` string — The Tag - `tagId` integer — The Tag ID - `value` string — The Tag Value - `widgets` Widget[] — An array of Widgets assigned to this Playlist - `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 - `permissions` Permission[] — An array of permissions - `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. - `folderId` integer — The id of the Folder this Playlist belongs to - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Playlist - `tags` TagLink[] — Tags associated with this Layout, array of TagLink objects - `tag` string — The Tag - `tagId` integer — The Tag ID - `value` string — The Tag Value - `folderId` integer — The id of the Folder this Layout belongs to - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Layout --- [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/revisions/fe497e811c7f/schema)