Content Page Resource

The Content Page resource represents a page for organising campaigns into structured layouts within the Spaaza platform. Content pages support hierarchical structures through parent-child relationships, and contain zones that define the layout of campaign content.

Contents

• Introduction
• Available Paths
• Properties
• Sample Content Page JSON

Introduction

A Content Page in Spaaza represents a structured layout page used to organise campaigns for display purposes. Content pages provide:

• A named page with an optional display name
• Hierarchical organisation through parent-child relationships
• Zones containing campaign content and layout information
• Ordering control for display sequencing

The Content Page resource supports all standard REST operations and can be identified by either its numeric ID or a unique name within a chain.

Available Paths

The Content Page resource supports the following API paths:

Single Resource Operations

• GET /resources/content-page/{id} - Retrieve a single content page by ID
• GET /resources/content-page?{identifier parameter}={value} - Retrieve a single content page (by identifier parameter)
• POST /resources/content-page - Create a new content page
• PATCH /resources/content-page?{identifier parameter}={value} - Update an existing content page (by identifier parameter)
• PATCH /resources/content-page/{id} - Update an existing content page (by ID)
• PUT /resources/content-page?{identifier parameter}={value} - Update an existing content page (by identifier parameter)
• PUT /resources/content-page/{id} - Update an existing content page (by ID)
• DELETE /resources/content-page?{identifier parameter}={value} - Delete a content page (by identifier parameter)
• DELETE /resources/content-page/{id} - Delete a content page (by ID)

Note: For single content page retrieval by identifier parameter, you can use any property marked with identifier: true in the "Spaaza Vendor Attributes" column in the Properties table below.

Multiple Resource Operations

• GET /resources/content-pages - Retrieve a list of content pages with optional filtering and pagination

Properties

The Content Page resource includes the following properties, listed alphabetically:

Name	Description	Standard Attributes(details)	Spaaza Vendor Attributes(details)
deleted	Whether the content page has been deleted	type: boolean nullable: false	recursionLevel: 1
display_name	Content page display name	type: string nullable: true maxLength: 255	recursionLevel: 0 operations: ["post", "put", "patch"]
id	Content page identifier	type: integer readOnly: true nullable: false	recursionLevel: 0 filter-property: true sort-by-property: true operations: ["get", "put", "patch", "delete"]
last_modified_date	Content page last modified date	type: date-time readOnly: true nullable: false	recursionLevel: 0 immutable: true sort-by-property: true
name	Content page name	type: string nullable: false minLength: 1 maxLength: 255	recursionLevel: 0 identifier: true filter-property: true sort-by-property: true required-in: ["post"] operations: ["post", "put", "patch", "get"]
order	Content page display order	type: integer nullable: false default: 0	recursionLevel: 0 sort-by-property: true operations: ["post", "put", "patch"]
parent	Name of the parent content page, if any	type: string nullable: true	recursionLevel: 0 operations: ["post", "put", "patch"]
zones	Array of zone objects belonging to the content page	type: array nullable: true	recursionLevel: 1 operations: ["post", "put", "patch"]

Property Notes

• Identifier Properties: The name property can be used as an alternative identifier to the numeric id for retrieving, updating, or deleting content pages. Properties marked with identifier: true can be used as identifier parameters for single resource operations.
• Filter Properties: Properties marked with filter-property: true can be used to filter results when retrieving multiple content pages.
• Parent Hierarchy: The parent property references another content page by name within the same chain, enabling hierarchical page structures. Setting parent to null or omitting it makes the content page a top-level page. A content page cannot reference itself or create circular parent relationships.
• Zones: The zones array contains zone objects that define the layout and content areas of the page. Each zone can contain items such as campaigns. Zones are managed as part of the content page and are replaced in full when updated.
• Recursion Levels: The recursionLevel attribute controls at which API response detail levels each property is included.
• Required Fields: Properties marked with required-in: ["post"] are required when creating new content pages. The name property is required when creating a content page.
• Operations: The operations attribute indicates which HTTP methods can use each property as a parameter.
• Deletion: Deleting a content page also deletes all of its descendant content pages in the hierarchy.

Sample Content Page JSON

Here is an example of a Content Page resource as returned by the API:

{
  "deleted": false,
  "display_name": "Summer Campaign Highlights",
  "id": 42,
  "last_modified_date": "2026-04-10T14:30:00Z",
  "name": "summer-highlights",
  "order": 1,
  "parent": "campaigns-overview",
  "zones": [
    {
      "title": "Featured Campaigns",
      "show_title": true,
      "mode": "manual",
      "tag_filter": "",
      "type_filter": "",
      "layout_type": "card",
      "orientation": "horizontal",
      "items": []
    }
  ]
}

This example shows a typical Content Page resource with a parent page reference, display ordering, and a single zone defining a campaign layout area.