CmsPage

PreviousReadonly NextSearch

cms Page Repository V1Get By Id Get

Retrieve page.

get

/V1/cmsPage/{pageId}

Path parameters

pageIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/cmsPage/{pageId}'

200

401

500

{
  "identifier": "<string>",
  "id": "<integer>",
  "title": "<string>",
  "page_layout": "<string>",
  "meta_title": "<string>",
  "meta_keywords": "<string>",
  "meta_description": "<string>",
  "content_heading": "<string>",
  "content": "<string>",
  "creation_time": "<string>",
  "update_time": "<string>",
  "sort_order": "<string>",
  "layout_update_xml": "<string>",
  "custom_theme": "<string>",
  "custom_root_template": "<string>",
  "custom_layout_update_xml": "<string>",
  "custom_theme_from": "<string>",
  "custom_theme_to": "<string>",
  "active": "<boolean>"
}

cms Page Repository V1Delete By Id Delete

Delete page by ID.

delete

/V1/cmsPage/{pageId}

Path parameters

pageIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/cmsPage/{pageId}'

200

400

401

500

true

cms Page Repository V1Save Post

Save page.

post

/V1/cmsPage

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"page":{"identifier":"<string>","id":"<integer>","title":"<string>","page_layout":"<string>","meta_title":"<string>","meta_keywords":"<string>","meta_description":"<string>","content_heading":"<string>","content":"<string>","creation_time":"<string>","update_time":"<string>","sort_order":"<string>","layout_update_xml":"<string>","custom_theme":"<string>","custom_root_template":"<string>","custom_layout_update_xml":"<string>","custom_theme_from":"<string>","custom_theme_to":"<string>","active":"<boolean>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/cmsPage' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": {
      "identifier": "<string>",
      "id": "<integer>",
      "title": "<string>",
      "page_layout": "<string>",
      "meta_title": "<string>",
      "meta_keywords": "<string>",
      "meta_description": "<string>",
      "content_heading": "<string>",
      "content": "<string>",
      "creation_time": "<string>",
      "update_time": "<string>",
      "sort_order": "<string>",
      "layout_update_xml": "<string>",
      "custom_theme": "<string>",
      "custom_root_template": "<string>",
      "custom_layout_update_xml": "<string>",
      "custom_theme_from": "<string>",
      "custom_theme_to": "<string>",
      "active": "<boolean>"
    }
  }'

200

401

500

{
  "identifier": "<string>",
  "id": "<integer>",
  "title": "<string>",
  "page_layout": "<string>",
  "meta_title": "<string>",
  "meta_keywords": "<string>",
  "meta_description": "<string>",
  "content_heading": "<string>",
  "content": "<string>",
  "creation_time": "<string>",
  "update_time": "<string>",
  "sort_order": "<string>",
  "layout_update_xml": "<string>",
  "custom_theme": "<string>",
  "custom_root_template": "<string>",
  "custom_layout_update_xml": "<string>",
  "custom_theme_from": "<string>",
  "custom_theme_to": "<string>",
  "active": "<boolean>"
}

cms Page Repository V1Save Put

Save page.

put

/V1/cmsPage/{id}

Path parameters

idstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"page":{"identifier":"<string>","id":"<integer>","title":"<string>","page_layout":"<string>","meta_title":"<string>","meta_keywords":"<string>","meta_description":"<string>","content_heading":"<string>","content":"<string>","creation_time":"<string>","update_time":"<string>","sort_order":"<string>","layout_update_xml":"<string>","custom_theme":"<string>","custom_root_template":"<string>","custom_layout_update_xml":"<string>","custom_theme_from":"<string>","custom_theme_to":"<string>","active":"<boolean>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/cmsPage/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "page": {
      "identifier": "<string>",
      "id": "<integer>",
      "title": "<string>",
      "page_layout": "<string>",
      "meta_title": "<string>",
      "meta_keywords": "<string>",
      "meta_description": "<string>",
      "content_heading": "<string>",
      "content": "<string>",
      "creation_time": "<string>",
      "update_time": "<string>",
      "sort_order": "<string>",
      "layout_update_xml": "<string>",
      "custom_theme": "<string>",
      "custom_root_template": "<string>",
      "custom_layout_update_xml": "<string>",
      "custom_theme_from": "<string>",
      "custom_theme_to": "<string>",
      "active": "<boolean>"
    }
  }'

200

401

500

{
  "identifier": "<string>",
  "id": "<integer>",
  "title": "<string>",
  "page_layout": "<string>",
  "meta_title": "<string>",
  "meta_keywords": "<string>",
  "meta_description": "<string>",
  "content_heading": "<string>",
  "content": "<string>",
  "creation_time": "<string>",
  "update_time": "<string>",
  "sort_order": "<string>",
  "layout_update_xml": "<string>",
  "custom_theme": "<string>",
  "custom_root_template": "<string>",
  "custom_layout_update_xml": "<string>",
  "custom_theme_from": "<string>",
  "custom_theme_to": "<string>",
  "active": "<boolean>"
}