Region Data Model

Editable regions in the current site.

Sample JSON Data

      {
        "data": {
          "type": "regions",
          "id": "aae07684-c294-41d7-8913-b328d7a58614",
          "attributes": {
            "title": "Main",
            "var-name": "main",
            "description": "Main content of the page.",
            "max-num-content": null,
            "position": 0,
            "created-at": "2012-04-23T18:25:43.511Z",
            "updated-at": "2012-04-23T18:25:43.511Z"
          },
          "relationships": {
            "content-templates": {
              "data": [
                {
                  "type": "content-templates",
                  "id": "a7607d9d-48b4-4bdf-8e90-e868efde3ca4"
                }
              ]
            }
          }
        }
      }

Attributes

Attribute Type Required Description
title string Yes Title of region.
var-name string No Variable name to reference this region within the layout.
description string No Description of region to appear to content authors in the admin interface.
max-num-content integer No Maximum number of content items that may be added to this region. Leave null to allow an infinite number of content items.
position integer Read-only Order in which this region appears in the layout’s markup.
created-at date Read-only Timestamp recording when region was created, localized to the current logged in user’s time zone.
updated-at date Read-only Date and time region record was last updated, localized to the current logged in user’s time zone.

Relationships

Title Type Required Description
content-templates array No Content templates that will be accepted into this region. This is useful to limit the type(s) of content that can be added to the region. Submit a blank array to clear this out and have no restrictions.

Related