Skip to content

Possible Field Types

Each component (block) can include the following field types:

Type Label Description
asset Asset A single uploaded file (image, video, audio, or document) with optional support for external URLs.
multiasset Asset (multi) Multiple uploaded files (images, videos, audio, or documents).
bloks Blocks A field for nesting other components, with configurable minimum and maximum limits.
boolean Boolean A toggle stored as true or false.
datetime Date/time A picker for ISO 8601 date values with optional time selection.
section Group A widget that visually groups other fields in the editor without affecting the API response.
multilink Link A link input for stories, URLs, assets, or email addresses.
markdown Markdown A text input stored as Markdown with a customizable toolbar.
number Number A numeric input with configurable minimum, maximum, decimals, and step.
option Option A single-select dropdown sourced from a list, stories, a datasource, or an external API.
options Option (multi) A multi-select dropdown sourced from a list, stories, a datasource, or an external API. Set is_reference_type: true to use it as a References field.
custom Plugin A custom field type. Refer to Introduction to Field Plugins to learn more.
richtext Rich text A formatted text input stored as JSON, based on the TipTap editor.
table Table A table editor with flexible columns and rows.
text Text A short text input with character limits and regex validation.
textarea Textarea A multi-line text input without formatting.
image Image (deprecated) A legacy upload field for a single image with cropping options.
file File (deprecated) A legacy upload field for a single file.
Example object
{
"component": {
"name": "hero_section",
"display_name": "Hero Section",
"schema": {
"title": {
"type": "text",
"display_name": "Title",
"required": true
},
"subtitle": {
"type": "textarea",
"display_name": "Subtitle"
}
}
}
}

Was this page helpful?

What went wrong?

This site uses reCAPTCHA and Google's Privacy Policy (opens in a new window).Terms of Service (opens in a new window) apply.