Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Storefront
Headless CMS
Managing Singleton content types
Managing Singleton content types

Singleton content types allow creating and managing a single page, ensuring that only one page of this content type exists in Headless CMS.

This content type avoids potential conflicts and inconsistencies when multiple pages of the same content type are created. For example, you can use Singleton for your store's Home page to ensure that there is only one Home page and that all updates and requests to this page always return the same result.

{"base64":"  ","img":{"width":1631,"height":651,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1424657,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Storefront/Headless%20CMS/managing-singleton-content-types_1.gif"}}

To create the Singleton content type, check with your developer team if the isSingleton property is implemented or ask them to follow the instructions in Using isSingleton in a content type to add it to the desired content type.

Creating the Singleton

  1. Access the Admin > Storefront > Headless CMS.
  2. Select CREATE NEW and choose the name of the singleton content type, for example, Home.
  3. Edit the page as you desire using new sections.

You can only create the Singleton once. The Singleton page will not be displayed in the content type list if it already exists.

Editing the Singleton

  1. Access the Admin > Storefront > Headless CMS.
  2. Click on the project where the Singleton were created.
  3. Select the Singleton that you created, for example, Home.
  4. On the Home page, edit as you desire by adding new sections.

Unpublishing the Singleton

  1. Access the Admin > Storefront > Headless CMS.
  2. Click the project where the Singleton was created.
  3. Click Unpublish > Unpublish Now.

Before unpublishing, make sure there are no existing drafts. Otherwise, you won't be able to proceed. If you have drafts, either delete them or schedule them for publication.

  1. A modal will display for you to confirm the unpublishing of the page.
  2. Click and hold UNPUBLISH to unpublish content.

Deleting the Singleton

  1. On the Singleton page, select more(kebab menu) and choose Delete.
  2. ChooseDELETE and BACK TO PAGES.

If you want to restore the page and its content, click RESTORE.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback