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"
}
}
}
}
}
Updates a CMS Section
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"
}
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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>
Record updated
The response is of type object
.
Was this page helpful?