Forms

Retrieve an active form for embedding.

Returns the active form type and subscriber fields required by a trusted website integration.

get/form-builder/{formId}/embedding

Request

  • Base URL: https://api.maildroppa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.maildroppa.com/form-builder/{formId}/embedding
  • Auth: API key in header X-API-Key

Path parameters

formIdstring uuid required

Unique identifier of the form.

Response

Active form embedding retrieved.

idstring uuid
type'DEFAULT' | 'SLIDER' | 'INLINE' | 'POPUP' | 'PAGE'

Example response

{
  "inputFields": [
    {
      "fieldRef": {
        "type": "BUILT_IN",
        "builtInField": "EMAIL"
      },
      "personalizationTagName": "favorite_topics",
      "label": "Favorite topics",
      "placeholder": "Choose one or more topics",
      "isRequired": true,
      "position": 2
    }
  ]
}

Changes

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