Widgets

Update saved popup

Changed on

Updates a saved popup. Only the fields you send change.

Set status to published to make the popup live, or draft to stop it showing while keeping the popup, its stats, and its embed script. trigger, targeting, schedule, frequency, and visual are merged key by key, so patching one key keeps the rest.

patch/popups/{popupId}

Request

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

Path parameters

popupIdstring required

Request body

namestring
status'draft' | 'published'
listIdsstring[]

Replacement list targeting. Pass an empty array to capture into every list.

tagIdsstring[]

Replacement tag IDs. Pass an empty array to clear tags.

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. Omit to keep the current setting.

headlinestring

New text for the popup's first heading block. Fails when the popup has no heading block.

descriptionstring

New text for the popup's first paragraph block. Fails when the popup has no paragraph block.

buttonTextstring
successMessagestring
redirectUrlstring

HTTP or HTTPS URL for successful signups. Pass an empty string to switch back to the confirmation message.

presentation'modal' | 'slide-in' | 'floating-bar' | 'fullscreen'
placement'center' | 'left' | 'right' | 'top' | 'bottom'
themeobject

Visual theme overrides merged into the current theme.

blocksobject[]

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

Response

Popup updated

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 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

    • 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

    • info

      added the optional property to the response with the status