Forms

Create a form (optionally publish it)

Requires the forms:write scope. Set publish=true to publish immediately; the form goes through FormBuilder's safety review and may be held (see publish_blocked_reasons). Free plan allows 5 forms.

post/api/v1/forms

Request

Base URL: https://api.formbuilder.com
URL: https://api.formbuilder.com/api/v1/forms
Auth: HTTP bearer

Request body

titlestring required

descriptionstring

submit_button_textstring

publishboolean

Example request

{
  "title": "Contact us",
  "publish": true,
  "fields": [
    {
      "label": "Name",
      "type": "text",
      "required": true
    },
    {
      "label": "Email",
      "type": "email",
      "required": true
    },
    {
      "label": "How can we help?",
      "type": "textarea"
    },
    {
      "label": "Topic",
      "type": "select",
      "options": [
        "Sales",
        "Support",
        "Other"
      ]
    }
  ]
}

Response

Created

idstring

titlestring

slugstring

status'draft' | 'published'

public_urlstring nullable

Live form URL when published

edit_urlstring

publish_blocked_reasonsstring[] nullable

fieldsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.