Skip to main content

Create/update page area family

Creates or updates a page area family.

Request Body — REQUIRED

The family model to create or update.

Id int32
Name string
FilterableProperties string[]

This page area family has access to the following properties that can be used for filtering, when rendering itself.
The following properties are available:
SiteId, LanguageId, ProductId, CategoryId, BrandId, InfoPageId, DiscountCampaignNumber, GenderId, Sale, UserTypeIdActiveFrom, ActiveTo

Areas object[]
Index int32

The primary id of this page are family collection

Name string

A descriptive, user-defined name for this page area family collection

FamilyId int32

The family this area belongs to.

Settings object
LazyLoadConfiguration object
EnableLazyloadMobile boolean
EagerLoadStepsMobile int32
EnableLazyloadDesktop boolean
EagerLoadStepsDesktop int32
LazyLoadCollectionConfigurations object[]
CollectionName string
EnableLazyloadMobile boolean
EagerLoadStepsMobile int32
EnableLazyloadDesktop boolean
EagerLoadStepsDesktop int32
WidgetRestrictions object
ContainerRestrictions object
AllowedLayouts int32[]

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8]

BannedWidgets uuid[]
Responses
200

The affected page area family.

Schema — OPTIONAL
Resource object — OPTIONAL
Id int32 — OPTIONAL
Name string — OPTIONAL
FilterableProperties string — OPTIONAL

This page area family has access to the following properties that can be used for filtering, when rendering itself.

Areas object[] — OPTIONAL
Index int32 — OPTIONAL

The primary id of this page are family collection

Name string — OPTIONAL

A descriptive, user-defined name for this page area family collection

FamilyId int32 — OPTIONAL

The family this area belongs to.

Settings string — OPTIONAL

The settings that determine how containers can be added to this area.

Containers object[] — OPTIONAL

The containers in this area

Id int32 — OPTIONAL

The primary ID of this container

Name string — OPTIONAL

The descriptive user defined name of this container, which is used to distinguish this container in a container library

ClassNames string[] — OPTIONAL

The CSS class names this container should use.

Active boolean — OPTIONAL
Layout string — OPTIONAL
ResponsiveMode string — OPTIONAL
Visibility string — OPTIONAL
Design string — OPTIONAL
Widgets object[] — OPTIONAL

The configured widgets held by this container

Id uuid — OPTIONAL

The IDs of widgets are immutable.

Name string — OPTIONAL

The static name of this widget. Used to translate into icons, or to append to css-classes.

Type string — OPTIONAL

The name of the widget-type.

Active boolean — OPTIONAL

Decides if this page widget is active or not.

ClassNames string[] — OPTIONAL

Holds all CSS Class names that this widget should render.

Size string — OPTIONAL

The fractional size for this widget in it's container.

Configuration string — OPTIONAL

The configuration for this page widget.

Message string — OPTIONAL

A status message for the action taken.

Details string[] — OPTIONAL

Any validation messages for the data on the current action.