Update form

patch

https://api.omnisend.com/api/forms/{formID}

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.

Scopes:
forms.write

Rate limit: 40 requests per minute.

Path Params

formID

string

required

Form ID

Body Params

Form fields to update

Request body for updating a form. Only formID (path) is mandatory; every body field is optional. Provided fields fully replace the stored value (nested objects must be sent complete); omitted fields are left unchanged. Sending null for a mandatory field (name, displayType, content, targeting) is rejected. Sending null for an optional field clears the stored value. Form status cannot be changed through this endpoint.

autoRedirect

object | null

Auto-redirect configuration shown after a successful submission.

clickOutside

object | null

Click-outside-to-close behavior configuration.

contactTags

array of strings | null

Tags applied to contacts who submit the form

contactTags

content

object

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

displayType

string

enum

Form display type

Allowed:

doubleOptIn

object | null

Double opt-in configuration.

name

string

Form name

recaptcha

object | null

reCAPTCHA protection settings.

socialMediaSharing

object | null

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

200Updated form

400Request contains invalid or missing fields

401Authentication is missing or invalid

403Insufficient permissions for this operation

404Form not found

410API version has been retired

429Rate limit exceeded

500Unexpected error occurred