OMomnisend
Forms

Update form

Partially update a form. Only the fields present in the request body are changed; omitted fields are left unchanged. Nested objects must be sent complete, as they fully replace the stored value. Sending null for an optional field clears it, while sending null for a mandatory field is rejected. Form status and creation origin cannot be changed through this endpoint.

Games: a mysteryBox or scratchCard block adds an interactive game to the form. A form may contain at most one game, it cannot be combined with a wheel of fortune, and the game's step must be placed before or at the first step containing a required email or phone field. The game reward is revealed to the visitor through a discount block of type game on the success step.

Scopes: forms.write

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

patch/forms/{formID}

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/forms/{formID}
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: forms.write
    • or API key in header Authorization

Path parameters

formIDstring required

Form ID

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Request body

contactTagsstring[] nullable

Tags applied to contacts who submit the form

displayType'popup' | 'landingPage' | 'embedded' | 'flyout' | 'fullscreen'

Form display type

namestring

Form name

Response

Updated form

abSetupIDstring

A/B setup unique identifier the form belongs to (read-only)

abStatus'enabled' | 'draft' | 'disabled'

A/B test status of a form. disabled is a launched A/B test that is currently paused.

contactTagsstring[]

Tags applied to contacts who submit the form

createdAtstring

Form creation timestamp (read-only)

disabledAtstring

Form disable timestamp (read-only)

displayType'popup' | 'landingPage' | 'embedded' | 'flyout' | 'fullscreen'

Form display type, controlling how the form is presented to visitors. popup is a modal centered over the page (highest visibility, best for offers and exit-intent); flyout is a compact panel anchored to a corner (non-intrusive, always-on signup); embedded renders inline within the host page's content (permanent signup block); landingPage is a full standalone page hosted by Omnisend (ad or link driven campaigns); fullscreen is a modal that covers the whole viewport (maximum attention, no surrounding page visible).

enabledAtstring

Form enable timestamp (read-only)

idstring

Form unique identifier (read-only)

launchedAtstring

Form launch timestamp (read-only)

namestring

Form name

status'enabled' | 'disabled' | 'draft'

Form status.

updatedAtstring

Form last update timestamp (read-only)

Changes

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