Create form

post

https://api.omnisend.com/api/forms

Create a form (popup, flyout, embedded, or landing page) with its full content and styling.

Scopes:
forms.write

Rate limit: 40 requests per minute.

Body Params

Form to create

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

autoRedirect

object

Auto-redirect configuration shown after a successful submission.

clickOutside

object

Click-outside-to-close behavior configuration.

contactTags

array of strings

length ≤ 100

Tags applied to contacts who submit the form

contactTags

content

object

required

Form content submitted when creating a form: general settings, steps, and optional success/subscribed/unavailable sections.

displayType

string

enum

required

Form display type

Allowed:

doubleOptIn

object

Double opt-in configuration.

name

string

required

Form name

recaptcha

object

reCAPTCHA protection settings.

socialMediaSharing

object

Social media sharing metadata.

targeting

object

Targeting rules controlling when and to whom a form is shown.

Headers

Omnisend-Version

string

required

Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created form

400Request contains invalid or missing fields

401Authentication is missing or invalid

403Insufficient permissions for this operation

410API version has been retired

429Rate limit exceeded

500Unexpected error occurred