Sign in

16ad4f8e3d97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-10244143882.9 KB
Widgets

Create saved popup

Creates a saved on-site signup popup and returns the one-line script tag that deploys it. The popup is published by default, so the script is live as soon as it is added to the site. Trigger, targeting, audience, and duplicate handling stay server-side, so the deployed script carries no API key.

Omit listIds to capture into every list, matching the dashboard default.

post/popups

Request body

namestring required
template'newsletter-modal' | 'discount-offer' | 'countdown-launch' | 'minimal-slide-in' | 'exit-lead-magnet' | 'live-demo' | 'launch-modal' | 'paper-digest' | 'stark-takeover' | 'top-bar' | 'announcement-bar' | 'fullscreen-welcome'

Starting design for the popup's blocks and theme.

status'draft' | 'published'
listIdsstring[]

Lists every signup is added to. Omit or pass an empty array to capture into every list.

tagIdsstring[]
duplicateStrategy'skip' | 'merge' | 'overwrite'
headlinestring
descriptionstring
buttonTextstring
successMessagestring
redirectUrlstring uri
presentation'modal' | 'slide-in' | 'floating-bar' | 'fullscreen'
placement'center' | 'left' | 'right' | 'top' | 'bottom'
themeobject

Optional visual theme overrides (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).

blocksobject[]

Complete replacement for the popup's content blocks. The popup must keep exactly one required email field and one submit button.

Response

Popup created

successboolean
messagestring

Example response

{
  "success": true
}