Skip to main content
POST
/
open
/
forms
Create Form
curl --request POST \
  --url https://api.opnform.com/open/forms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workspace_id": 123,
  "title": "<string>",
  "visibility": "public",
  "tags": [
    "<string>"
  ],
  "language": "<string>",
  "custom_domain": "<string>",
  "theme": "default",
  "font_family": "<string>",
  "color": "<string>",
  "dark_mode": "light",
  "width": "centered",
  "size": "sm",
  "border_radius": "none",
  "layout_rtl": true,
  "uppercase_labels": true,
  "cover_picture": "<string>",
  "logo_picture": "<string>",
  "no_branding": true,
  "transparent_background": true,
  "submit_button_text": "<string>",
  "submitted_text": "<string>",
  "redirect_url": "<string>",
  "re_fillable": true,
  "re_fill_button_text": "<string>",
  "confetti_on_submission": true,
  "show_progress_bar": true,
  "closes_at": "2023-11-07T05:31:56Z",
  "closed_text": "<string>",
  "max_submissions_count": 2,
  "max_submissions_reached_text": "<string>",
  "auto_save": true,
  "auto_focus": true,
  "enable_partial_submissions": true,
  "editable_submissions": true,
  "editable_submissions_button_text": "<string>",
  "password": "<string>",
  "use_captcha": true,
  "captcha_provider": "recaptcha",
  "can_be_indexed": true,
  "seo_meta": {},
  "custom_code": "<string>",
  "database_fields_update": [
    "<any>"
  ],
  "properties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "name": "<string>",
      "help": "<string>",
      "hidden": true,
      "required": true,
      "placeholder": "<string>",
      "width": "full"
    }
  ]
}'
{
  "id": 123,
  "slug": "<string>",
  "title": "<string>",
  "visibility": "public",
  "tags": [
    "<string>"
  ],
  "language": "<string>",
  "custom_domain": "<string>",
  "theme": "default",
  "font_family": "<string>",
  "color": "<string>",
  "dark_mode": "light",
  "width": "centered",
  "size": "sm",
  "border_radius": "none",
  "layout_rtl": true,
  "uppercase_labels": true,
  "cover_picture": "<string>",
  "logo_picture": "<string>",
  "no_branding": true,
  "transparent_background": true,
  "submit_button_text": "<string>",
  "submitted_text": "<string>",
  "redirect_url": "<string>",
  "re_fillable": true,
  "re_fill_button_text": "<string>",
  "confetti_on_submission": true,
  "show_progress_bar": true,
  "closes_at": "2023-11-07T05:31:56Z",
  "closed_text": "<string>",
  "max_submissions_count": 2,
  "max_submissions_reached_text": "<string>",
  "auto_save": true,
  "auto_focus": true,
  "enable_partial_submissions": true,
  "editable_submissions": true,
  "editable_submissions_button_text": "<string>",
  "password": "<string>",
  "use_captcha": true,
  "captcha_provider": "recaptcha",
  "can_be_indexed": true,
  "seo_meta": {},
  "custom_code": "<string>",
  "database_fields_update": [
    "<any>"
  ],
  "properties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "name": "<string>",
      "help": "<string>",
      "hidden": true,
      "required": true,
      "placeholder": "<string>",
      "width": "full"
    }
  ]
}

​
Create Form

Create a new form within a workspace.

​
Authentication & Scope

Requires a Personal Access Token with the forms-write ability.

​
Request

POST /open/forms HTTP/1.1
Host: api.opnform.com
Content-Type: application/json
Authorization: Bearer <token>

​
Body Parameters

FieldTypeRequiredDescription
workspace_idnumberYesID of the workspace that will own the form.
titlestringYesHuman-readable title shown in the dashboard.
visibilitystringYesOne of public, draft, or closed.
languagestringYesTwo-letter ISO language code (e.g. en).
propertiesarrayYesArray of form blocks (see FormProperty schema).
…other fieldsmixedNoSee the Form schema for the full list of attributes.
Example request: 
{
  "workspace_id": 1,
  "title": "Event Registration",
  "visibility": "public",
  "language": "en",
  "properties": [
    {
      "id": "field-1",
      "type": "short_text",
      "name": "First name",
      "required": true
    }
  ]
}

​
Response

201 Created – Returns the full Form object. 
{
  "id": 99,
  "slug": "event-registration",
  "title": "Event Registration",
  "visibility": "public",
  "properties": [...]
}
403 Forbidden – The token does not include the forms-write ability.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Body

application/json
​
workspace_id
number

ID of the workspace that owns the form.

​
title
string

The title of the form.

​
visibility
enum<string>

The current visibility state of the form.

Available options:
public,
draft,
closed
​
tags
string[] | null
​
language
string

Two-letter ISO language code.

​
custom_domain
string | null
​
theme
enum<string>
Available options:
default,
simple,
notion
​
font_family
string | null
​
color
string
​
dark_mode
enum<string>
Available options:
light,
dark,
auto
​
width
enum<string>
Available options:
centered,
full
​
size
enum<string>
Available options:
sm,
md,
lg
​
border_radius
enum<string>
Available options:
none,
small,
full
​
layout_rtl
boolean
​
uppercase_labels
boolean
​
cover_picture
string<uri> | null
​
logo_picture
string<uri> | null
​
no_branding
boolean

Whether to hide the OpnForm branding.

​
transparent_background
boolean

Transparent background when form is embedded.

​
submit_button_text
string
Maximum length: 50
​
submitted_text
string
Maximum length: 2000
​
redirect_url
string<uri> | null
​
re_fillable
boolean
​
re_fill_button_text
string
Maximum length: 50
​
confetti_on_submission
boolean
​
show_progress_bar
boolean
​
closes_at
string<date-time> | null
​
closed_text
string | null
​
max_submissions_count
integer | null
Required range: x >= 1
​
max_submissions_reached_text
string | null
​
auto_save
boolean
​
auto_focus
boolean
​
enable_partial_submissions
boolean
​
editable_submissions
boolean
​
editable_submissions_button_text
string
Maximum length: 50
​
password
string | null
​
use_captcha
boolean
​
captcha_provider
enum<string>
Available options:
recaptcha,
hcaptcha
​
can_be_indexed
boolean
​
seo_meta
object | null
​
custom_code
string | null
​
database_fields_update
any[] | null
​
properties
object[]

An array of field and layout blocks that make up the form.

Response

Form created

​
id
number

The unique identifier for the form.

​
slug
string

The URL-friendly slug for the form.

​
title
string

The title of the form.

​
visibility
enum<string>

The current visibility state of the form.

Available options:
public,
draft,
closed
​
tags
string[] | null
​
language
string

Two-letter ISO language code.

​
custom_domain
string | null
​
theme
enum<string>
Available options:
default,
simple,
notion
​
font_family
string | null
​
color
string
​
dark_mode
enum<string>
Available options:
light,
dark,
auto
​
width
enum<string>
Available options:
centered,
full
​
size
enum<string>
Available options:
sm,
md,
lg
​
border_radius
enum<string>
Available options:
none,
small,
full
​
layout_rtl
boolean
​
uppercase_labels
boolean
​
cover_picture
string<uri> | null
​
logo_picture
string<uri> | null
​
no_branding
boolean

Whether to hide the OpnForm branding.

​
transparent_background
boolean

Transparent background when form is embedded.

​
submit_button_text
string
Maximum length: 50
​
submitted_text
string
Maximum length: 2000
​
redirect_url
string<uri> | null
​
re_fillable
boolean
​
re_fill_button_text
string
Maximum length: 50
​
confetti_on_submission
boolean
​
show_progress_bar
boolean
​
closes_at
string<date-time> | null
​
closed_text
string | null
​
max_submissions_count
integer | null
Required range: x >= 1
​
max_submissions_reached_text
string | null
​
auto_save
boolean
​
auto_focus
boolean
​
enable_partial_submissions
boolean
​
editable_submissions
boolean
​
editable_submissions_button_text
string
Maximum length: 50
​
password
string | null
​
use_captcha
boolean
​
captcha_provider
enum<string>
Available options:
recaptcha,
hcaptcha
​
can_be_indexed
boolean
​
seo_meta
object | null
​
custom_code
string | null
​
database_fields_update
any[] | null
​
properties
object[]

An array of field and layout blocks that make up the form.