CMS Footers API Reference

Manage website footer components, links, and footer-related operations in the CMS system.

Base Path: /api/cms-footers

Overview

The CMS Footers API provides endpoints for managing website footer components including creation, editing, activation, and listing. Supports multiple footer variations with activation workflow.

Key Operations

Create footer components
Update footer content
Activate footers for public use
List and delete footers

API Endpoints

POST /api/cms-footers

Create Footer

Creates a new footer component.

Authentication

Bearer Token

Request Body

{
  "name": "Main Footer v1",
  "html": "...",
  "css": "footer { background: #333; color: #fff; }",
  "isActive": false,
  "description": "Main website footer with links"
}

Response

{
  "id": "footer_123",
  "name": "Main Footer v1",
  "isActive": false,
  "createdAt": "2026-06-02T10:30:00Z"
}

GET /api/cms-footers/{id}

Get Footer by ID

Gets footer component details by ID.

Authentication

Bearer Token

Path Parameters

Parameter	Type
id	string

Response

{
  "id": "footer_123",
  "name": "Main Footer v1",
  "html": "...",
  "css": "footer { background: #333; color: #fff; }",
  "isActive": false,
  "description": "Main website footer with links",
  "createdAt": "2026-06-02T10:30:00Z"
}

GET /api/cms-footers

List Footers

Gets all footer components with pagination.

Authentication

Bearer Token

Query Parameters

Parameter	Type	Description
$skip	integer	Skip n records
$top	integer	Take n records

Response

{
  "value": [
    {
      "id": "footer_123",
      "name": "Main Footer v1",
      "isActive": true,
      "createdAt": "2026-06-02T10:30:00Z"
    }
  ],
  "count": 8
}

PUT /api/cms-footers/{id}

Update Footer

Updates footer component details.

Authentication

Bearer Token

Request Body

{
  "name": "Main Footer v2",
  "html": "Updated...",
  "css": "footer { background: #2c2c2c; color: #fff; }",
  "description": "Updated main footer"
}

Response

{
  "id": "footer_123",
  "name": "Main Footer v2",
  "updatedAt": "2026-06-02T11:00:00Z"
}

DELETE /api/cms-footers/{id}

Delete Footer

Soft deletes a footer component.

Authentication

Bearer Token

Response

{
  "success": true,
  "message": "Footer deleted"
}

POST /api/cms-footers/{id}/activate

Activate Footer

Activates a footer component for public use (deactivates others).

Authentication

Bearer Token

Response

{
  "id": "footer_123",
  "isActive": true,
  "activatedAt": "2026-06-02T11:05:00Z"
}

Error Responses

Code	HTTP Status	Description
FOOTER_NOT_FOUND	404	Footer component does not exist
INVALID_HTML	400	Invalid HTML content
DUPLICATE_NAME	409	Footer name already exists

Quick Links

← Back to Overview ← CMS Headers API Reports API → Try the Playground