Skip to content
You are reading the unreleased documentation. No version is released yet, and these pages describe code that is not in a release.

Pages (admin API)

Admin routes of the pages module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

List all CMS pages including unpublished

Parameters:

  • page in query (number, min 1, optional).
  • pageSize in query (number, min 1, max 100, optional).

Responses:

  • 200: no description.

Create new CMS page

Request body: CreatePageAdminDto.

Responses:

  • 201: no description.

Soft-delete CMS page

Parameters:

  • id in path (string, required).

Responses:

  • 204: no description.

Update CMS page

Parameters:

  • id in path (string, required).

Request body: UpdatePageAdminDto.

Responses:

  • 200: no description.
  • slug (string, pattern /^(?:\/[a-z0-9-]+)+$/, max length 200, required).
  • type (object, required).
  • title (TranslatableDto, required).
  • content (TranslatableDto, required).
  • isPublished (boolean, optional).
  • metaTitle (TranslatableDto, optional).
  • metaDescription (TranslatableDto, optional).
  • sortOrder (number, min 0, optional).
  • showInNavigation (boolean, optional).
  • template (string, max length 100, optional).
  • default (string, required).
  • fr (string, optional).
  • en (string, optional).
  • ar (string, optional).