Widgets

Create saved popup

Changed on

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

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/popups
  • Auth
    HTTP bearer

Request body

namestring required
template'newsletter-modal' | 'discount-offer' | 'scratch-to-reveal' | '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'
resubscribeBehavior'reactivate' | 'double_opt_in'

What happens when a contact who unsubscribed from all email submits this popup again. reactivate resubscribes them and restores the popup's lists. double_opt_in sends the workspace confirmation email first and resubscribes them when they confirm. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400; if either is removed later, returning unsubscribed contacts stay unsubscribed. Workspace double opt-in always requires confirmation. duplicateStrategy never changes subscription status.

botProtectionboolean

Run a Cloudflare Turnstile bot check before each signup, invisibly for most visitors. Signups that fail it must confirm by email before they are subscribed. Turning it on requires a double opt-in confirmation email and a sender profile, otherwise the request returns 400. If either is removed later, those signups get a 400 asking them to try again.

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
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new scratch-to-reveal enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status