Skip to main content
POST
/
api
/
v1
/
forms
/
{companyId}
Submit Signup Form
curl --request POST \
  --url https://api.sequenzy.com/api/v1/forms/{companyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "customAttributes[fieldKey]": "<string>",
  "customAttributes": {},
  "duplicateStrategy": "<string>",
  "duplicateStrategyToken": "<string>",
  "listIds[]": [
    "<string>"
  ],
  "tagIds[]": [
    "<string>"
  ],
  "website": "<string>",
  "redirectUrl": "<string>"
}
'
{"success": true}

Submit Signup Form

You can submit an embedded signup form or popup without an API key. The endpoint accepts application/x-www-form-urlencoded form posts and JSON.
Forms created in the dashboard post to the saved form endpoint, which stores audience targeting and success behavior server-side. This company-level endpoint keeps working for popups and existing deployed embeds.

Request

companyId
string
required
Your company ID.
email
string
required
The subscriber’s email address.
firstName
string
The subscriber’s first name.
lastName
string
The subscriber’s last name.
customAttributes[fieldKey]
string
Submit a subscriber custom attribute from an HTML form, for example customAttributes[nickname]=Ace.
customAttributes
object
JSON alternative for custom integrations.
lists
string
Comma-separated list IDs. Omit this to use your workspace default lists, or use an empty lists= value to add the subscriber to no lists.
tags
string
Comma-separated tag IDs to apply to the subscriber.
duplicateStrategy
string
default:"skip"
How to handle an existing contact with the submitted email. Use skip to preserve existing fields, merge to fill only missing fields, or overwrite to replace submitted fields. merge and overwrite require a matching duplicateStrategyToken from the Sequenzy form builder.
duplicateStrategyToken
string
Signed token generated by the Sequenzy form builder for the selected duplicateStrategy. Required when duplicateStrategy is merge or overwrite.
duplicateStrategy
string
default:"skip"
Body alternative to the duplicateStrategy query parameter for custom integrations. Query parameter takes precedence when both are present. merge and overwrite require a matching duplicateStrategyToken.
duplicateStrategyToken
string
Body alternative to the duplicateStrategyToken query parameter.
listIds[]
string[]
Existing deployed embed format for repeated list IDs.
tagIds[]
string[]
Existing deployed embed format for repeated tag IDs.
website
string
Honeypot field. Leave it empty.
redirectUrl
string
http or https URL, or a domain such as google.com, to redirect visitors to after a successful submission.
curl -X POST "https://api.sequenzy.com/api/v1/forms/company_123?lists=list_abc123,list_def456&tags=tag_abc123&duplicateStrategy=merge&duplicateStrategyToken=SIGNED_TOKEN" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "email=user@example.com" \
  --data-urlencode "customAttributes[nickname]=Ace"

Responses

{"success": true}