Widgets

Submit saved popup

Changed on

Submit a saved popup without an API key. The popup's stored content is the source of truth for audience targeting, duplicate handling, resubscribe behavior, custom fields, and success behavior.

A contact who unsubscribed from all email is resubscribed and their target list memberships are restored. When the popup's resubscribeBehavior is double_opt_in, or workspace double opt-in is on, they receive a confirmation email instead. The response does not reveal which case applied.

post/forms/popups/{popupId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/forms/popups/{popupId}
  • Auth
    none required

Path parameters

popupIdstring required

The saved popup ID

Request body

emailstring email required

Subscriber email address

firstNamestring
lastNamestring
phonestring

Subscriber phone number in E.164 or US national format, when configured on the popup. Stored on the base subscriber profile and does not grant SMS consent.

customAttributesobject

Subscriber custom attributes for custom fields configured on the popup

websitestring

Honeypot field. Leave empty.

sequenzyTokenstring

Signed bot-protection token that Sequenzy's hosted embed script and popups add automatically. Custom integrations can omit it. Submissions without a valid token may be asked to confirm by email. Workspaces with strict protection ignore submissions without a token, or with a token for a different form or popup, and return the normal success response.

sequenzyBotCheckTokenstring

Cloudflare Turnstile token that the hosted embed script and popups add automatically when the form or popup has bot protection on. Custom integrations cannot obtain one. When bot protection is on, submissions without a valid token must confirm by email before they are subscribed; if the workspace's confirmation email or sender was removed after bot protection was turned on, they return 400 with a retry message instead. Ignored when bot protection is off.

Example request

{
  "email": "user@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "phone": "+12133734253",
  "customAttributes": {
    "company_size": "42"
  }
}

Response

Popup submitted successfully

successboolean
redirectUrlstring uri

Present when the popup is configured to redirect after submission

Example response

{
  "success": true,
  "reward": {
    "value": "10% off your first order",
    "code": "WELCOME10"
  }
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the optional property to the response with the status

  • ad2202945c5bRevision changes
    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: application/json)