Update a CMS Section - Spree Commerce documentation

Community

Github

API basics

Tutorials

Quick Checkout with Stripe and Storefront API

Storefront API

Authentication
Account
Account / Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Stripe
Products
Vendors
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
- GET
  Return a list of CMS Sections
- POST
  Create a CMS Section
- GET
  Return a CMS Section
- DEL
  Delete a CMS Section
- PATCH
  Update a CMS Section
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Vendors
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

PATCH

api

platform

cms_sections

{id}

curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/cms_sections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cms_section": {
    "name": "<string>",
    "type": "Spree::Cms::Sections::ProductCarousel",
    "linked_resource_type": "Spree::Taxon",
    "linked_resource_id": "1",
    "fit": "Screen",
    "position": 2,
    "gutters": "No Gutters",
    "button_text": "Click Here",
    "title": "Shop Today"
  }
}'

{
  "data": {
    "id": "29",
    "type": "cms_section",
    "attributes": {
      "name": "Super Hero",
      "content": {},
      "settings": {
        "gutters": "No Gutters"
      },
      "fit": "Screen",
      "destination": null,
      "type": "Spree::Cms::Sections::HeroImage",
      "position": 1,
      "linked_resource_type": "Spree::Product",
      "created_at": "2022-11-08T19:34:05.290Z",
      "updated_at": "2022-11-08T19:34:05.525Z"
    },
    "relationships": {
      "cms_page": {
        "data": {
          "id": "20",
          "type": "cms_page"
        }
      },
      "linked_resource": {
        "data": {
          "id": "28",
          "type": "product"
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

include

string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

Body

application/json

cms_section

object

required

cms_section

object

required

cms_section

object

required

cms_section

object

required

cms_section.name

string

Update this section name.

cms_section.type

enum<string>

Change the section type.

Available options:

Spree::Cms::Sections::HeroImage,

Spree::Cms::Sections::FeaturedArticle,

Spree::Cms::Sections::ProductCarousel,

Spree::Cms::Sections::ImageGallery,

Spree::Cms::Sections::SideBySideImages,

Spree::Cms::Sections::RichTextContent

Example:

"Spree::Cms::Sections::ProductCarousel"

cms_section.position

integer

Pass the position that you want this section to appear in. (The list is not zero indexed, so the first item is position: 1)

Example:

2

cms_section.link_type_one

enum<string>

Update the resource type that image one links to.

Available options:

Spree::Taxon,

Spree::Product

Example:

"Spree::Taxon"

cms_section.link_type_two

enum<string>

Update the resource type that image two links to.

Available options:

Spree::Taxon,

Spree::Product

Example:

"Spree::Taxon"

cms_section.link_one

string | null

Update the slug or path that image two links to.

Example:

"men/shirts"

cms_section.link_two

string | null

Update the slug or path that image two links to.

Example:

"white-shirt"

cms_section.title_one

string | null

Update the title used in image one.

Example:

"Shop Men's Shirts"

cms_section.title_two

string | null

Update the title used in image two.

Example:

"Buy This Men's Shirt"

cms_section.fit

enum<string>

This value is used by front end developers to set CSS classes for content that fits the screen edge-to-edge, or stays within the boundaries of the central container.

Available options:

Screen,

Container

Example:

"Screen"

cms_section.subtitle_one

string | null

Update the subtitle used in image one.

Example:

"Save 50% today"

cms_section.subtitle_two

string | null

Update the subtitle used in image two.

Example:

"Save 50% today"

cms_section.gutters

enum<string>

This value is used by front end developers for styling the section padding.

Available options:

Gutters,

No Gutters

Example:

"No Gutters"

cms_section.cms_section[image_one]

file

Use a multipart/form-data request to upload assets.

cms_section.cms_section[image_two]

file

Use a multipart/form-data request to upload assets.

cms_section

object

required

cms_section

object

required

cms_section.name

string

Update this section name.

cms_section.type

enum<string>

Change the section type.

Available options:

Spree::Cms::Sections::HeroImage,

Spree::Cms::Sections::FeaturedArticle,

Spree::Cms::Sections::ProductCarousel,

Spree::Cms::Sections::ImageGallery,

Spree::Cms::Sections::SideBySideImages,

Spree::Cms::Sections::RichTextContent

Example:

"Spree::Cms::Sections::ProductCarousel"

cms_section.position

integer

Pass the position that you want this section to appear in. (The list is not zero indexed, so the first item is position: 1)

Example:

2

cms_section.link_type_one

enum<string>

Update the resource type that image one links to.

Available options:

Spree::Taxon,

Spree::Product

Example:

"Spree::Taxon"

cms_section.link_type_two

enum<string>

Update the resource type that image two links to.

Available options:

Spree::Taxon,

Spree::Product

Example:

"Spree::Taxon"

cms_section.link_type_three

enum<string>

Update the resource type that image three links to.

Available options:

Spree::Taxon,

Spree::Product

Example:

"Spree::Taxon"

cms_section.link_one

string | null

Update the slug or path that image two links to.

Example:

"men/shirts"

cms_section.link_two

string | null

Update the slug or path that image two links to.

Example:

"white-shirt"

cms_section.link_three

string | null

Update the slug or path that image three links to.

Example:

"red-shirt"

cms_section.title_one

string | null

Update the title used in image one.

Example:

"Shop Men's Shirts"

cms_section.title_two

string | null

Update the title used in image two.

Example:

"Buy This Men's Shirt"

cms_section.title_three

string | null

Update the title used in image three.

Example:

"Buy This Women's Skirt"

cms_section.fit

enum<string>

This value is used by front end developers to set CSS classes for content that fits the screen edge-to-edge, or stays within the boundaries of the central container.

Available options:

Screen,

Container

Example:

"Screen"

cms_section.layout_style

enum<string>

This value is used by front end developers for styling the order the images appear.

Available options:

Default,

Reversed

Example:

"Default"

cms_section.display_labels

enum<string>

This value is used by front end developers for showing and hiding the label on the images.

Available options:

Show,

Hide

Example:

"Show"

cms_section.cms_section[image_one]

file

Use a multipart/form-data request to upload assets.

cms_section.cms_section[image_two]

file

Use a multipart/form-data request to upload assets.

cms_section.cms_section[image_three]

file

Use a multipart/form-data request to upload assets.

cms_section

object

required

Response

200

application/vnd.api+json

Record updated

data

object

required

Was this page helpful?

Suggest edits Raise issue

Returns a list of CountriesReturns a list of Countries

curl --request PATCH \
  --url http://{defaultHost}/api/v2/platform/cms_sections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cms_section": {
    "name": "<string>",
    "type": "Spree::Cms::Sections::ProductCarousel",
    "linked_resource_type": "Spree::Taxon",
    "linked_resource_id": "1",
    "fit": "Screen",
    "position": 2,
    "gutters": "No Gutters",
    "button_text": "Click Here",
    "title": "Shop Today"
  }
}'

{
  "data": {
    "id": "29",
    "type": "cms_section",
    "attributes": {
      "name": "Super Hero",
      "content": {},
      "settings": {
        "gutters": "No Gutters"
      },
      "fit": "Screen",
      "destination": null,
      "type": "Spree::Cms::Sections::HeroImage",
      "position": 1,
      "linked_resource_type": "Spree::Product",
      "created_at": "2022-11-08T19:34:05.290Z",
      "updated_at": "2022-11-08T19:34:05.525Z"
    },
    "relationships": {
      "cms_page": {
        "data": {
          "id": "20",
          "type": "cms_page"
        }
      },
      "linked_resource": {
        "data": {
          "id": "28",
          "type": "product"
        }
      }
    }
  }
}