Skip to content
em sa em sa

Preview Cms Content

POST
/api/superadmin/cms/{page_id}/preview
 
curl --request POST \
  --url https://example.com/api/superadmin/cms/example/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "content": { "additionalProperty": "example" } }'

Preview merged content with draft overrides applied on top of live content.

Does NOT persist changes — use PATCH to publish.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
page_id
required
Page Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
CMSPreviewRequest

Request model for POST /api/superadmin/cms/{page_id}/preview.

object
content
required
Content
object
key
additional properties
string
Example generated
{
  "content": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
CMSPreviewResponse

Response model for POST /api/superadmin/cms/{page_id}/preview.

object
page_id
required
Page Id
string
content
required
Content
object
key
additional properties
string
Example generated
{
  "page_id": "example",
  "content": {
    "additionalProperty": "example"
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}