Forms

Disable form

Disable a single form by ID. Disabling stops serving the form to visitors and moves it to disabled status; the form and its content are preserved and can be enabled again later. Disabling an already disabled form succeeds (idempotent).

A/B test version forms cannot be disabled directly, and a form that owns an active A/B test cannot be disabled; manage the A/B setup instead.

Scopes: forms.write

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

post/forms/{formID}/disable

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/forms/{formID}/disable
  • 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

Response

Form disabled

Changes

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