CMS Headers API Reference

Manage website header components, navigation, and header-related operations in the CMS system.

Base Path: /api/cms-headers

Overview

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

Key Operations

API Endpoints

POST /api/cms-headers

Create Header

Creates a new header component.

Authentication

Bearer Token

Request Body

{
  "name": "Main Header v1",
  "html": "
",
  "css": "header { background: #fff; }",
  "isActive": false,
  "description": "Main website header with navigation"
}

Response

{
  "id": "header_123",
  "name": "Main Header v1",
  "isActive": false,
  "createdAt": "2026-06-02T10:30:00Z"
}
GET /api/cms-headers/{id}

Get Header by ID

Gets header component details by ID.

Authentication

Bearer Token

Path Parameters

Parameter Type
id string

Response

{
  "id": "header_123",
  "name": "Main Header v1",
  "html": "
",
  "css": "header { background: #fff; }",
  "isActive": false,
  "description": "Main website header with navigation",
  "createdAt": "2026-06-02T10:30:00Z"
}
GET /api/cms-headers

List Headers

Gets all header components with pagination.

Authentication

Bearer Token

Query Parameters

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

Response

{
  "value": [
    {
      "id": "header_123",
      "name": "Main Header v1",
      "isActive": true,
      "createdAt": "2026-06-02T10:30:00Z"
    }
  ],
  "count": 10
}
PUT /api/cms-headers/{id}

Update Header

Updates header component details.

Authentication

Bearer Token

Request Body

{
  "name": "Main Header v2",
  "html": "
",
  "css": "header { background: #f5f5f5; }",
  "description": "Updated main header"
}

Response

{
  "id": "header_123",
  "name": "Main Header v2",
  "updatedAt": "2026-06-02T11:00:00Z"
}
DELETE /api/cms-headers/{id}

Delete Header

Soft deletes a header component.

Authentication

Bearer Token

Response

{
  "success": true,
  "message": "Header deleted"
}
POST /api/cms-headers/{id}/activate

Activate Header

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

Authentication

Bearer Token

Response

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

Error Responses

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

Quick Links

← Back to Overview ← CMS Pages API CMS Footers API → Try the Playground