Widgets

Create saved form

Changed on

Creates and publishes a saved signup form. Its opaque form ID becomes a client-safe public capability while audience and success settings remain server-side.

post/forms

Request

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

Request body

namestring required
listIdsstring[] required
tagIdsstring[]
duplicateStrategy'skip' | 'merge' | 'overwrite'
resubscribeBehavior'reactivate' | 'double_opt_in'

What happens when a contact who unsubscribed from all email submits this form again. reactivate resubscribes them and restores the form'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. The hosted JavaScript embed runs it, invisibly for most visitors. Signups that fail it, or come from the plain HTML form snippet, which cannot run 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.

buttonTextstring
headlinestring
descriptionstring
successMessagestring
redirectUrlstring uri
showFirstNameboolean
showLastNameboolean
themeobject

Optional visual theme overrides (accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor as "#rrggbb", borderRadius 0-32, headingFontFamily, bodyFontFamily, density).

Response

Form created and published

successboolean

Example response

{
  "success": true
}

Changes

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

  • db3873ca3d4dRevision changes
    • 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

      the response's property default value changed from {"duplicateStrategy":"skip","listMode":"all","listIds":[],"tagIds":[],"afterSubmission":"message","redirectUrl":""} to {"duplicateStrategy":"skip","resubscribeBehavior":"reactivate","listMode":"all","listIds":[],"tagIds":[],"afterSubmission":"message","redirectUrl":""} for the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status