displayGroup

Action: Overlay Layout

Changed on

Send the overlay layout action to this DisplayGroup, you can pass layoutId or layout specific campaignId

post/displaygroup/{displayGroupId}/action/overlayLayout

Request

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

Path parameters

displayGroupIdinteger required

This can be either a Display Group or the Display specific Display Group

Request body application/x-www-form-urlencoded

layoutIdinteger required

The ID of the Layout to change to. Either this or a campaignId must be provided.

campaignIdinteger

The Layout specific campaignId of the Layout to change to. Either this or a layoutId must be provided.

durationinteger

The duration in seconds for this Overlay to remain in effect

downloadRequiredinteger

Whether to queue or replace with this action. Queuing will keep the current change layout action and switch after it is finished. If no active change layout action is present, both options are actioned immediately

Response

successful operation

Changes