POST
/
zones
Post zone
curl --request POST \
  --url https://{FUSION_HOST.com}/api/templating/zones \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Results List",
  "id": "6a092bd4-5098-466c-94aa-40bf68294303",
  "type": "result-list",
  "queryProfile": "fusion-query-profile-name",
  "omitFilters": false,
  "dirty": true,
  "neverPublished": true,
  "metadata": {
    "image": "image-id",
    "primary": "primary-metadata-id",
    "secondary": "_text_"
  },
  "inTemplates": [
    "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
  ],
  "staging": false,
  "published": false,
  "layout": "grid"
}'
{
  "name": "Results List",
  "id": "6a092bd4-5098-466c-94aa-40bf68294303",
  "type": "result-list",
  "queryProfile": "fusion-query-profile-name",
  "omitFilters": false,
  "dirty": true,
  "neverPublished": true,
  "metadata": {
    "image": "image-id",
    "primary": "primary-metadata-id",
    "secondary": "_text_"
  },
  "inTemplates": [
    "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
  ],
  "staging": false,
  "published": false,
  "layout": "grid"
}

Query Parameters

​
context
string

The context parameter retrieves templates for the specified application. The parameter format is app:your-app-name. Only the first application listed in the context is displayed even if a comma-delimited list is entered in the parameter.

Example:

"app:your-app-name"

Body

application/json
​
id
string<uuid>
required

The universal unique identifier (UUID) of the zone.

Example:

"6a092bd4-5098-466c-94aa-40bf68294303"

​
name
string

The name of the zone that contains the specified query profiles to search in the query.

Example:

"Results List"

​
type
string

Read-only value that classifies the zone in the Fusion Predictive Merchandiser UI. This value does not affect the triggering/rendering logic.

Example:

"result-list"

​
queryProfile
string

The query profile for this zone, that designates the endpoint that is searched.

Example:

"fusion-query-profile-name"

​
omitFilters
boolean
default:false

Specifies whether to include filters fq parameters in the search. If set to Off, all query parameters in the original request are passed on to the defined query profile when a template is being rendered. If set to On, all filters (fq parameters) from the original request are omitted from the query to the query profile. For example, if you have a category landing page where the category is used to filter the displayed items, this setting can allow a zone to display items outside of that category (by omitting the category filter).

​
dirty
boolean

The status of the template. If false, the template is published. If true, this is the staging version of this template and it contains changes that have not yet been published.

​
neverPublished
boolean

The status of the template in the zone. If false, the template has been published at some point. If true, this template has never been published.

​
metadata
object

Additional data associated with this zone.

​
inTemplates
string[]

IDs of the staging and/or published templates in which this zone appears. The IDs are not displayed in any particular order. The staging and published boolean fields specify if that type of template ID is returned in this field.

​
staging
boolean
default:false

Specifies if IDs are returned for staging templates associated with this zone.

​
published
boolean
default:false

Specifies if IDs are returned for published templates associated with this zone.

​
layout
string

The type of layout for the template. Values include grid and list.

Example:

"grid"

Response

OK

​
id
string<uuid>
required

The universal unique identifier (UUID) of the zone.

Example:

"6a092bd4-5098-466c-94aa-40bf68294303"

​
name
string

The name of the zone that contains the specified query profiles to search in the query.

Example:

"Results List"

​
type
string

Read-only value that classifies the zone in the Fusion Predictive Merchandiser UI. This value does not affect the triggering/rendering logic.

Example:

"result-list"

​
queryProfile
string

The query profile for this zone, that designates the endpoint that is searched.

Example:

"fusion-query-profile-name"

​
omitFilters
boolean
default:false

Specifies whether to include filters fq parameters in the search. If set to Off, all query parameters in the original request are passed on to the defined query profile when a template is being rendered. If set to On, all filters (fq parameters) from the original request are omitted from the query to the query profile. For example, if you have a category landing page where the category is used to filter the displayed items, this setting can allow a zone to display items outside of that category (by omitting the category filter).

​
dirty
boolean

The status of the template. If false, the template is published. If true, this is the staging version of this template and it contains changes that have not yet been published.

​
neverPublished
boolean

The status of the template in the zone. If false, the template has been published at some point. If true, this template has never been published.

​
metadata
object

Additional data associated with this zone.

​
inTemplates
string[]

IDs of the staging and/or published templates in which this zone appears. The IDs are not displayed in any particular order. The staging and published boolean fields specify if that type of template ID is returned in this field.

​
staging
boolean
default:false

Specifies if IDs are returned for staging templates associated with this zone.

​
published
boolean
default:false

Specifies if IDs are returned for published templates associated with this zone.

​
layout
string

The type of layout for the template. Values include grid and list.

Example:

"grid"