Sign in

16ad4f8e3d97

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

Update saved popup

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}

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