v1
latestOpenAPI 3.0.12026-07-26331033.7 KBForms
Create Form
Create a new form; requires forms-write ability.
post/open/forms
Request body
idnumber
The unique identifier for the form.
slugstring
The URL-friendly slug for the form.
workspace_idnumber
ID of the workspace that owns the form.
titlestring
The title of the form.
visibility'public' | 'draft' | 'closed'
The current visibility state of the form.
tagsstring[] nullable
languagestring
Two-letter ISO language code.
custom_domainstring nullable
theme'default' | 'simple' | 'notion'
font_familystring nullable
colorstring
dark_mode'light' | 'dark' | 'auto'
width'centered' | 'full'
size'sm' | 'md' | 'lg'
border_radius'none' | 'small' | 'full'
layout_rtlboolean
uppercase_labelsboolean
cover_picturestring uri nullable
logo_picturestring uri nullable
no_brandingboolean
Whether to hide the OpnForm branding.
transparent_backgroundboolean
Transparent background when form is embedded.
submit_button_textstring
submitted_textstring
redirect_urlstring uri nullable
re_fillableboolean
re_fill_button_textstring
confetti_on_submissionboolean
show_progress_barboolean
closes_atstring date-time nullable
closed_textstring nullable
max_submissions_countinteger nullable
max_submissions_reached_textstring nullable
auto_saveboolean
auto_focusboolean
enable_partial_submissionsboolean
editable_submissionsboolean
editable_submissions_button_textstring
passwordstring nullable
use_captchaboolean
captcha_provider'recaptcha' | 'hcaptcha'
can_be_indexedboolean
seo_metaobject nullable
custom_codestring nullable
Response
Form created
idnumber
The unique identifier for the form.
slugstring
The URL-friendly slug for the form.
workspace_idnumber
ID of the workspace that owns the form.
titlestring
The title of the form.
visibility'public' | 'draft' | 'closed'
The current visibility state of the form.
tagsstring[] nullable
languagestring
Two-letter ISO language code.
custom_domainstring nullable
theme'default' | 'simple' | 'notion'
font_familystring nullable
colorstring
dark_mode'light' | 'dark' | 'auto'
width'centered' | 'full'
size'sm' | 'md' | 'lg'
border_radius'none' | 'small' | 'full'
layout_rtlboolean
uppercase_labelsboolean
cover_picturestring uri nullable
logo_picturestring uri nullable
no_brandingboolean
Whether to hide the OpnForm branding.
transparent_backgroundboolean
Transparent background when form is embedded.
submit_button_textstring
submitted_textstring
redirect_urlstring uri nullable
re_fillableboolean
re_fill_button_textstring
confetti_on_submissionboolean
show_progress_barboolean
closes_atstring date-time nullable
closed_textstring nullable
max_submissions_countinteger nullable
max_submissions_reached_textstring nullable
auto_saveboolean
auto_focusboolean
enable_partial_submissionsboolean
editable_submissionsboolean
editable_submissions_button_textstring
passwordstring nullable
use_captchaboolean
captcha_provider'recaptcha' | 'hcaptcha'
can_be_indexedboolean
seo_metaobject nullable
custom_codestring nullable