Skip to content

Custom Schemas

Define the field structure for your collection objects using the schema editor

intermediate10 min readFor portal users

Custom Schemas

Every collection has a schema that defines what fields each object contains. The schema editor lets you design your data structure visually — no code required.

What is a Schema?

A schema is the blueprint for your content. It lists every field an object can have, along with each field's type, label, and validation rules. When someone creates a new object in the collection, the form they see is generated directly from the schema.

For example, a "Blog Posts" schema might include:

  • Title — Short Text (required)
  • Body — Structured / Long Text
  • Author — Short Text
  • Publish Date — Date
  • Featured Image — Image
  • Category — Custom Choices

Opening the Schema Editor

  1. Navigate to Collections from the bottom navigation bar.
  2. Tap the collection you want to configure — this opens the collection dialog.
  3. The schema editor is displayed in the dialog, showing your current fields. You can add, remove, or reorder them directly.

Field Types

The schema editor supports the following field types:

TypeDescriptionExample Use
Short TextSingle-line stringProduct name, author name
Structured / Long TextMulti-line formatted content (rich text editor)Blog body, product description
Whole NumberInteger valueQuantity, stock count
Decimal NumberNumeric value with decimalsPrice, rating
True / FalseBoolean toggleIs featured, is published
DateDate pickerPublish date, event date
Date & TimeDate and time pickerAppointment time, event start
TimeTime-only pickerOpening hours, schedule
Custom ChoicesDropdown with predefined optionsCategory, status, priority
ColorColor picker valueBrand color, accent color
Slug (URL Name)URL-safe stringPage slug, SEO URL
ImageImage file uploadFeatured image, headshot
VideoVideo file uploadProduct demo, hero video
File UploadAny file typePDF attachment, document
List of ItemsFreeform list of valuesIngredients, features
Linked CollectionReference to another collectionLink authors to posts
List of ObjectsMultiple references to another collectionRelated products, tagged items
Variant FieldControls other fields based on selected valuesSize/color product variants

Adding a Field

Click Add Field

In the schema editor, click the Add Field button to create a new entry.

Name the field

Enter a name for the field. This is how it appears in the object editor and in API responses (e.g., "Title", "Price", "Featured Image").

Choose the field type

Select the appropriate type from the dropdown. The type determines what kind of input the object form renders.

Configure options

Depending on the type, you may see additional options:

  • Required — toggle the required checkbox to make the field mandatory.
  • Options — for Custom Choices and Variant fields, click the Options button to define the list of allowed values.
  • Affects — for Variant fields, click the Affects button to select which other fields this variant controls.

Save the schema

Click Save to persist your changes. Existing objects are not retroactively modified — new fields will appear empty on older objects until they're edited.

Changing a field's type after objects already exist can cause display issues. If you need a different type, it's safer to add a new field and migrate data manually.

Variant Keys

Variant keys are a special schema feature for products or any content that has multiple options. They define the axes of variation — for example, "Size" and "Color" for a clothing product.

When you add a Variant Field to your schema, you define the possible values (e.g., "Small", "Medium", "Large") and select which other fields it affects (e.g., "Price", "SKU"). When editing an object, each variant value gets its own entry for the affected fields.

Variant keys are most useful for ecommerce collections. If you're building a blog or portfolio, you can skip this feature.

Schema Best Practices

  • Keep field names descriptive — use clear names like "Featured Image" or "Publish Date" so your team knows what each field is for.
  • Mark essential fields as required — this prevents incomplete content from being saved.
  • Use Structured / Long Text sparingly — it's powerful but adds weight. Use Short Text for simple values like names and titles.
  • Plan before building — changing schemas after creating hundreds of objects is tedious. Take a few minutes to plan your fields upfront.

Next Steps

With your schema defined, you're ready to manage objects — create, edit, and organize the actual content entries.