Update Popup - Sequenzy

PATCH

api

popups

{popupId}

Update Popup

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/popups/{popupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "status": "<string>",
  "listIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "duplicateStrategy": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "buttonText": "<string>",
  "successMessage": "<string>",
  "redirectUrl": "<string>",
  "presentation": "<string>",
  "placement": "<string>",
  "trigger": {},
  "targeting": {},
  "schedule": {},
  "frequency": {},
  "visual": {},
  "theme": {},
  "blocks": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/popups/{popupId}"

payload = {
    "name": "<string>",
    "status": "<string>",
    "listIds": ["<string>"],
    "tagIds": ["<string>"],
    "duplicateStrategy": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "buttonText": "<string>",
    "successMessage": "<string>",
    "redirectUrl": "<string>",
    "presentation": "<string>",
    "placement": "<string>",
    "trigger": {},
    "targeting": {},
    "schedule": {},
    "frequency": {},
    "visual": {},
    "theme": {},
    "blocks": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    status: '<string>',
    listIds: ['<string>'],
    tagIds: ['<string>'],
    duplicateStrategy: '<string>',
    headline: '<string>',
    description: '<string>',
    buttonText: '<string>',
    successMessage: '<string>',
    redirectUrl: '<string>',
    presentation: '<string>',
    placement: '<string>',
    trigger: {},
    targeting: {},
    schedule: {},
    frequency: {},
    visual: {},
    theme: {},
    blocks: [{}]
  })
};

fetch('https://api.sequenzy.com/api/v1/popups/{popupId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/popups/{popupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'status' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'tagIds' => [
        '<string>'
    ],
    'duplicateStrategy' => '<string>',
    'headline' => '<string>',
    'description' => '<string>',
    'buttonText' => '<string>',
    'successMessage' => '<string>',
    'redirectUrl' => '<string>',
    'presentation' => '<string>',
    'placement' => '<string>',
    'trigger' => [
        
    ],
    'targeting' => [
        
    ],
    'schedule' => [
        
    ],
    'frequency' => [
        
    ],
    'visual' => [
        
    ],
    'theme' => [
        
    ],
    'blocks' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/popups/{popupId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/popups/{popupId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/popups/{popupId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "popup": {
    "id": "pop_123",
    "name": "Welcome offer",
    "status": "published",
    "viewCount": 1840,
    "conversionCount": 96
  },
  "embed": {
    "scriptUrl": "https://sequenzy.com/embed/popups/pop_123?v=capture-runtime-20260716-14"
  },
  "message": "Popup updated."
}

{ "error": "Click-triggered popups require a click selector." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Popup not found" }

{ "error": "Failed to update popup." }

Update 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. The trigger, targeting, schedule, frequency, and visual objects are merged key by key, so patching one key keeps the rest.

Request

string

Internal popup name.

string

draft or published.

string[]

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

string[]

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

string

skip, merge, or overwrite.

string

New text for the popup’s first heading block. Fails when the popup has no heading block; edit blocks instead.

string

New text for the popup’s first paragraph block. Fails when the popup has no paragraph block; edit blocks instead.

string

Submit button label.

string

Success screen message.

string

HTTP or HTTPS success redirect. Pass an empty string to switch back to the confirmation message.

string

modal, slide-in, floating-bar, or fullscreen.

string

center, left, right, top, or bottom.

object

Partial trigger patch, merged into the current trigger.

object

Partial targeting patch, merged into the current targeting.

object

Partial schedule patch, merged into the current schedule.

object

Partial frequency patch, merged into the current frequency.

object

Partial visual patch, merged into the current visual. The image style requires an https imageUrl - the image panel is painted as a background, so a missing or blocked image would leave an empty column beside your content.

object

Theme overrides merged into the current theme.

object[]

Complete replacement for the popup’s content blocks. Read the current blocks with Get Popup first. The popup must keep exactly one required email field and one submit button. See Content blocks below.

curl -X PATCH "https://api.sequenzy.com/api/v1/popups/pop_123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "headline": "Take 15% off your first order",
    "targeting": { "paths": ["/pricing"], "device": "desktop" }
  }'

Unpublish a popup without deleting it:

curl -X PATCH "https://api.sequenzy.com/api/v1/popups/pop_123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "draft" }'

Content blocks

Blocks render in array order. Every block needs an id that is unique across the entire block tree and a kind. Content blocks may also set sectionId to "success" or "error" to render inside that screen. Input blocks use kind: "form-field" and follow the same shape as saved forms. Properties outside a kind’s list are rejected with a named error rather than dropped, so a typo is reported instead of saving an empty block.

Kind	Properties
`group`	`label`, `layout` (`stack` \| `row` \| `grid` \| `overlay`), `columns` (1-4), `gap` (0-64), `padding` (0-64), `overlayColor`, `overlayPosition` (`top` \| `center` \| `bottom`), `overlayShade` (0-100), `children`
`heading`	`content` (required), `level` (1-3), `align`
`text`	`content` (required), `variant` (`paragraph` \| `eyebrow` \| `caption`), `align`
`image`	`src` (required), `alt`, `fit` (`cover` \| `contain`)
`button`	`text` (required), `url`, `variant`, `align`
`divider`	none
`spacer`	`height` (8-160)
`custom-html`	`html` (required), `height` (40-1200)
`feature-grid`	`features` (`[{ "title": "...", "description": "..." }]`), `columns` (1-4)
`testimonial`	`testimonials` (`[{ "quote": "...", "name": "...", "role": "..." }]`)
`countdown`	`label`, `endsAt` (required, ISO 8601)
`form-step`	`title`, `description`, `blockIds`
`submit-button`	`text` (required), `width`
`success-screen`	`heading`, `message`
`error-state`	`message`

Use kind: "group" to lay out related children as a vertical stack, an equal-column row, a fixed-column grid, or an image overlay. Responsive rows and grids collapse to one column on small screens; groups may nest up to three levels. Overlay needs exactly one direct image child and supports overlayColor, overlayShade (0-100), and overlayPosition (top, center, or bottom). gap spaces the foreground children without moving the background image. Nested images only enable Overlay for their subgroup; zero or multiple direct images fall back to Stack. IDs remain unique across the full tree. A group and all descendants must use the same sectionId when they belong to a success or error screen. form-step, success-screen, and error-state blocks remain at the root. See the saved form layout group example for the full shape. A custom-html block carries its markup in html - not content - and sizes its frame with height in pixels:

{
  "id": "code-chip",
  "kind": "custom-html",
  "sectionId": "success",
  "html": "<div class=\"chip\">WELCOME15</div>",
  "height": 90
}

Responses

{
  "success": true,
  "popup": {
    "id": "pop_123",
    "name": "Welcome offer",
    "status": "published",
    "viewCount": 1840,
    "conversionCount": 96
  },
  "embed": {
    "scriptUrl": "https://sequenzy.com/embed/popups/pop_123?v=capture-runtime-20260716-14"
  },
  "message": "Popup updated."
}

{ "error": "Click-triggered popups require a click selector." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Popup not found" }

{ "error": "Failed to update popup." }

Update Popup

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/popups/{popupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "status": "<string>",
  "listIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "duplicateStrategy": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "buttonText": "<string>",
  "successMessage": "<string>",
  "redirectUrl": "<string>",
  "presentation": "<string>",
  "placement": "<string>",
  "trigger": {},
  "targeting": {},
  "schedule": {},
  "frequency": {},
  "visual": {},
  "theme": {},
  "blocks": [
    {}
  ]
}
'

import requests

url = "https://api.sequenzy.com/api/v1/popups/{popupId}"

payload = {
    "name": "<string>",
    "status": "<string>",
    "listIds": ["<string>"],
    "tagIds": ["<string>"],
    "duplicateStrategy": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "buttonText": "<string>",
    "successMessage": "<string>",
    "redirectUrl": "<string>",
    "presentation": "<string>",
    "placement": "<string>",
    "trigger": {},
    "targeting": {},
    "schedule": {},
    "frequency": {},
    "visual": {},
    "theme": {},
    "blocks": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    status: '<string>',
    listIds: ['<string>'],
    tagIds: ['<string>'],
    duplicateStrategy: '<string>',
    headline: '<string>',
    description: '<string>',
    buttonText: '<string>',
    successMessage: '<string>',
    redirectUrl: '<string>',
    presentation: '<string>',
    placement: '<string>',
    trigger: {},
    targeting: {},
    schedule: {},
    frequency: {},
    visual: {},
    theme: {},
    blocks: [{}]
  })
};

fetch('https://api.sequenzy.com/api/v1/popups/{popupId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/popups/{popupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'status' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'tagIds' => [
        '<string>'
    ],
    'duplicateStrategy' => '<string>',
    'headline' => '<string>',
    'description' => '<string>',
    'buttonText' => '<string>',
    'successMessage' => '<string>',
    'redirectUrl' => '<string>',
    'presentation' => '<string>',
    'placement' => '<string>',
    'trigger' => [
        
    ],
    'targeting' => [
        
    ],
    'schedule' => [
        
    ],
    'frequency' => [
        
    ],
    'visual' => [
        
    ],
    'theme' => [
        
    ],
    'blocks' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/popups/{popupId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sequenzy.com/api/v1/popups/{popupId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/popups/{popupId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"status\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"presentation\": \"<string>\",\n  \"placement\": \"<string>\",\n  \"trigger\": {},\n  \"targeting\": {},\n  \"schedule\": {},\n  \"frequency\": {},\n  \"visual\": {},\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "popup": {
    "id": "pop_123",
    "name": "Welcome offer",
    "status": "published",
    "viewCount": 1840,
    "conversionCount": 96
  },
  "embed": {
    "scriptUrl": "https://sequenzy.com/embed/popups/pop_123?v=capture-runtime-20260716-14"
  },
  "message": "Popup updated."
}

{ "error": "Click-triggered popups require a click selector." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Popup not found" }

{ "error": "Failed to update popup." }

​Request

​Content blocks

​Responses

Request

Content blocks

Responses