OMomnisend
Forms

Render a form

Render a single form by ID and return its display steps as HTML. The form is rendered from its current stored content without enabling it or serving it to visitors, so the response can be used to preview how the form will look. Each step is returned separately, preserving the form's multi-step order.

Scopes: forms.write

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

post/forms/{formID}/render

Request

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

Rendered form steps

Example response

{
  "steps": [
    {
      "html": "<div>step content</div>",
      "name": "Step 1"
    }
  ]
}

Changes

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