Widgets

Submit saved signup form by company

Changed on

Compatibility path for saved signup form submissions. New embeds should use /forms/{formId}.

The form's stored settings are the source of truth for audience targeting (lists, tags) and success behavior (success message or redirect URL), so dashboard edits apply to deployed embeds without re-embedding. List, tag, and redirect values in the request are ignored.

post/forms/{companyIdOrFormId}/{formId}

Request

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

Path parameters

companyIdOrFormIdstring required

The company ID the form belongs to

formIdstring required

The saved form 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 saved form. Stored on the base subscriber profile and does not grant SMS consent.

customAttributesobject

Subscriber custom attributes for custom fields configured on the saved form

listIdsstring[]

Ignored for saved forms. Stored form settings are used.

listIds[]string[]

Ignored for saved forms. Stored form settings are used.

tagIdsstring[]

Ignored for saved forms. Stored form settings are used.

tagIds[]string[]

Ignored for saved forms. Stored form settings are used.

duplicateStrategy'skip' | 'merge' | 'overwrite'

Ignored for saved forms. Stored form settings are used.

duplicateStrategyTokenstring

Ignored for saved forms. Stored form settings are used.

redirectUrlstring

Ignored for saved forms. Stored form settings are used.

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": {
    "nickname": "Ace",
    "favorite_fruit": "Mango"
  }
}

Response

Form submitted successfully. Native HTML form posts that accept text/html receive a hosted confirmation page showing the form's success message instead of JSON.

successboolean

Example response

{
  "success": true
}

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)

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