Create form

Create a form with its full content and styling. New forms start in draft status and are not shown to
visitors until enabled via POST /forms/{formID}/enable.

Choosing a display type:

  • popup — modal centered over the page that dims the background. Highest visibility; best for launch offers,
    discounts, and exit-intent capture where interrupting the visitor is acceptable.
  • flyout — compact panel anchored to a page corner that leaves the page usable. Less intrusive; suited to
    always-on signup while the visitor keeps browsing.
  • embedded — rendered inline within the host page's content. Use for a permanent signup block placed in a
    section, sidebar, or footer rather than an overlay.
  • landingPage — full standalone page hosted by Omnisend. Use for campaigns driven by ads, emails, or shared
    links where there is no host site to embed into.
  • fullscreen — overlay that covers the entire viewport. Maximum attention; best for high-value offers where
    taking over the screen is justified.

Content structure: content is a tree of stepssectionsrowscolumnsblocks. A step is
one screen of the form (up to two steps are allowed); each block (text, image, button, input field, wheel of
fortune, etc.) carries its own configuration and an optional style preset. Server-generated IDs on sections,
rows, columns, and blocks are assigned on create and may be omitted from the request.

Scopes:
forms.write

Rate Limiting:
This endpoint is rate limited to 40 requests per minute.

Body Params

Form to create

Request body for creating a form (popup, flyout, fullscreen, embedded, or landing page).

autoRedirect
object

Auto-redirect configuration applied after submission

clickOutside
object

Click-outside-to-close behavior

contactTags
array of strings
length ≤ 100

Tags applied to contacts who submit the form

contactTags
content
object
required

Form content

string
enum
required

Form display type

Allowed:
doubleOptIn
object

Double opt-in configuration

string
required

Form name

recaptcha
object

reCAPTCHA protection settings

socialMediaSharing
object

Social media sharing metadata

targeting
object

Form targeting rules

Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json