Guides
Customize the guest sidebar
This configuration only impacts Guests and not Admins. Learn more about user access.

Flatfile allows you to update your sidebar to hide/show certain elements via the Space endpoint.

Simply update metadata.sidebarConfig when calling spaces.update().


Building a guest sidebar

Learn how to create a sidebar configuration, and update a sidebar configuration from an event listener.

const updateSpace = await api.spaces.update(spaceId, {
  environmentId: environmentId,
  metadata: {
    sidebarConfig: {
      //See reference for all possible variables
    }
  }
});

Guest sidebar reference

metadata.sidebarConfig

Sidebar Config

showGuestInvite
boolean
The Collaborators link in the sidebar allows anyone to add another Guest to the Space.
showDataChecklist
boolean
The data checklist shows all of the data needed for uploading to the primary Workbook.
showSidebar
boolean
The sidebar as a whole can be hidden.