CMS page models

CMS page models for lists, details, creation and updates. Check localized content, publication fields and validation constraints.

Data schemas

Response metadata

AnalyticsPageMeta · Schema · CMS page models

paginationPagination Required: Cursor pagination metadata.

Example: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Required: Reporting period and its boundaries.

Example: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringRequired: Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100

Example: "example"

Additional fields: No

List CMS pages — Response

ApiResponse_list_PageSummaryData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <PageSummaryData > Required: Response example · ApiResponse_list_PageSummaryData__.

Example: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Additional fields: No

Get a CMS page — Response

ApiResponse_PageDetailData_ · Fields, types and constraints of data accepted or returned by the API.

dataPageDetailData Required: Response example · PageDetailData.

Example: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Additional fields: No

Create a CMS page — Request body

PageCreate · Fields, types and constraints of data accepted or returned by the API.

body_htmlString nullOptional

Page content in HTML.

String:maxLength: 100000

market_idsArray <String> Optional

Identifiers of selected markets.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringOptional

Whether the resource applies to all or selected markets.

Constraints

enum: ["all", "selected"]

meta_descriptionString nullOptional

Search-engine description in the selected language.

String:maxLength: 160

meta_keywordsArray <String> nullOptional

Search-engine keywords in the selected language.

Array:maxItems: 20

Array / Array:maxLength: 60

meta_titleString nullOptional

Search-engine title in the selected language.

String:maxLength: 70

publishedBooleanOptional

Whether the resource is published.

Default: false

slugString nullOptional

URL path segment in the selected language.

String:maxLength: 160

titleStringRequired

Title in the selected language.

minLength: 1maxLength: 300

Example: "Example"

Additional fields: No

Get a CMS page — Response

PageDetailData · Fields, types and constraints of data accepted or returned by the API.

body_htmlString nullRequired

Page content in HTML.

Example: "<p>Example</p>"

created_atStringRequired

Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

idStringRequired

Resource identifier; preserve it as returned. (PageDetailData).

Example: "example"

is_availableBooleanRequired

Whether the item is available in this context.

Example: true

market_scopeStringRequired

Whether the resource applies to all or selected markets.

Constraints

enum: ["all", "selected"]

Example: "all"

meta_descriptionString nullRequired

Search-engine description in the selected language.

Example: "example"

meta_keywordsArray <String> nullRequired

Search-engine keywords in the selected language.

Example: ["example"]

meta_titleString nullRequired

Search-engine title in the selected language.

Example: "example"

numberStringRequired

Human-facing order or request number.

Example: "example"

publishedBooleanRequired

Whether the resource is published.

Example: false

slugString nullRequired

URL path segment in the selected language.

Example: "example"

titleString nullRequired

Title in the selected language.

Example: "example"

updated_atStringRequired

Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 1

Additional fields: No

List CMS pages — Response

PageSummaryData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired

Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

idStringRequired

Resource identifier; preserve it as returned. (PageSummaryData).

Example: "example"

is_availableBooleanRequired

Whether the item is available in this context.

Example: true

market_scopeStringRequired

Whether the resource applies to all or selected markets.

Constraints

enum: ["all", "selected"]

Example: "all"

numberStringRequired

Human-facing order or request number.

Example: "example"

publishedBooleanRequired

Whether the resource is published.

Example: false

slugString nullRequired

URL path segment in the selected language.

Example: "example"

titleString nullRequired

Title in the selected language.

Example: "example"

updated_atStringRequired

Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"

versionIntegerRequired

Resource version used for concurrency control.

Example: 1

Additional fields: No

Update a CMS page — Request body

PageUpdate · Fields, types and constraints of data accepted or returned by the API.

body_htmlString nullOptional

Page content in HTML.

String:maxLength: 100000

expected_versionIntegerRequired

Version read before the write; a mismatch rejects the update.

minimum: 1maximum: 2147483647

Example: 1

market_idsArray <String> Optional

Identifiers of selected markets.

maxItems: 1000

Array:minLength: 1maxLength: 63

market_scopeStringOptional

Whether the resource applies to all or selected markets.

Constraints

enum: ["all", "selected"]

meta_descriptionString nullOptional

Search-engine description in the selected language.

String:maxLength: 160

meta_keywordsArray <String> nullOptional

Search-engine keywords in the selected language.

Array:maxItems: 20

Array / Array:maxLength: 60

meta_titleString nullOptional

Search-engine title in the selected language.

String:maxLength: 70

publishedBooleanOptional

Whether the resource is published.

slugString nullOptional

URL path segment in the selected language.

String:maxLength: 160

titleString nullOptional

Title in the selected language.

String:maxLength: 300

Example: "Example"

Additional fields: No