Sign in
layout

Tag Layout

Tag a Layout with one or more tags

post/layout/{layoutId}/tag

Path parameters

layoutIdinteger required

The Layout Id to Tag

Response

successful operation

layoutIdinteger

The layoutId

ownerIdinteger

The userId of the Layout Owner

campaignIdinteger

The id of the Layout's dedicated Campaign

parentIdinteger

The parentId, if this Layout has a draft

publishedStatusIdinteger

The Status Id

publishedStatusstring

The Published Status (Published, Draft or Pending Approval

publishedDatestring

The Published Date

backgroundImageIdinteger

The id of the image media set as the background

schemaVersioninteger

The XLF schema version

layoutstring

The name of the Layout

descriptionstring

The description of the Layout

backgroundColorstring

A HEX string representing the Layout background color

createdDtstring

The datetime the Layout was created

modifiedDtstring

The datetime the Layout was last modified

statusinteger

Flag indicating the Layout status

retiredinteger

Flag indicating whether the Layout is retired

backgroundzIndexinteger

The Layer that the background should occupy

widthnumber double

The Layout Width

heightnumber double

The Layout Height

orientationstring

The Layout Orientation

displayOrderinteger

If this Layout has been requested by Campaign, then this is the display order of the Layout within the Campaign

durationinteger

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.

statusMessagestring

A status message detailing any errors with the layout

enableStatinteger

Flag indicating whether the Layout stat is enabled

autoApplyTransitionsinteger

Flag indicating whether the default transitions should be applied to this Layout

codestring

Code identifier for this Layout

isLockedboolean

Is this layout locked by another user?

folderIdinteger

The id of the Folder this Layout belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Layout

Changes

Changed in 2 of the 52 revisions of this API.31

  • 41c04de98ec511See the full diff
    • ▲

      added required request body

      request-body-added-required

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8e12753951042See the full diff
    • ▲

      removed the request body

      request-body-removed

    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog