Submit Signup Form

POST

api

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>",
  "phone": "<string>",
  "customAttributes[fieldKey]": "<string>",
  "customAttributes": {},
  "duplicateStrategy": "<string>",
  "duplicateStrategyToken": "<string>",
  "listIds[]": [
    "<string>"
  ],
  "tagIds[]": [
    "<string>"
  ],
  "website": "<string>",
  "redirectUrl": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/forms/{companyId}"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "customAttributes[fieldKey]": "<string>",
    "customAttributes": {},
    "duplicateStrategy": "<string>",
    "duplicateStrategyToken": "<string>",
    "listIds[]": ["<string>"],
    "tagIds[]": ["<string>"],
    "website": "<string>",
    "redirectUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    phone: '<string>',
    'customAttributes[fieldKey]': '<string>',
    customAttributes: {},
    duplicateStrategy: '<string>',
    duplicateStrategyToken: '<string>',
    'listIds[]': ['<string>'],
    'tagIds[]': ['<string>'],
    website: '<string>',
    redirectUrl: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/forms/{companyId}', 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/forms/{companyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'phone' => '<string>',
    'customAttributes[fieldKey]' => '<string>',
    'customAttributes' => [
        
    ],
    'duplicateStrategy' => '<string>',
    'duplicateStrategyToken' => '<string>',
    'listIds[]' => [
        '<string>'
    ],
    'tagIds[]' => [
        '<string>'
    ],
    'website' => '<string>',
    'redirectUrl' => '<string>'
  ]),
  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/forms/{companyId}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.sequenzy.com/api/v1/forms/{companyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}"

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

{"success": true}

Location: https://example.com/thank-you

{ "success": false, "message": "Please enter a valid email address" }

{
  "success": false,
  "message": "Please enter a valid redirect URL"
}

{ "success": false, "message": "This email address cannot be subscribed" }

{ "success": false, "message": "Invalid form configuration" }

{ "success": false, "message": "Too many requests. Please try again later." }

{ "success": false, "message": "An error occurred. Please try again." }

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

string

required

Your company ID.

string

required

The subscriber’s email address.

string

The subscriber’s first name.

string

The subscriber’s last name.

string

The subscriber’s phone number in E.164 or US national format. It is stored on the base subscriber profile and does not grant SMS consent.

string

Submit a subscriber custom attribute from an HTML form, for example customAttributes[nickname]=Ace.

object

JSON alternative for custom integrations.

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.

string

Comma-separated tag IDs to apply to the subscriber.

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.

string

Signed token generated by the Sequenzy form builder for the selected duplicateStrategy. Required when duplicateStrategy is merge or overwrite.

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.

string

Body alternative to the duplicateStrategyToken query parameter.

string[]

Existing deployed embed format for repeated list IDs.

string[]

Existing deployed embed format for repeated tag IDs.

string

Honeypot field. Leave it empty.

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}

Location: https://example.com/thank-you

{ "success": false, "message": "Please enter a valid email address" }

{
  "success": false,
  "message": "Please enter a valid redirect URL"
}

{ "success": false, "message": "This email address cannot be subscribed" }

{ "success": false, "message": "Invalid form configuration" }

{ "success": false, "message": "Too many requests. Please try again later." }

{ "success": false, "message": "An error occurred. Please try again." }

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>",
  "phone": "<string>",
  "customAttributes[fieldKey]": "<string>",
  "customAttributes": {},
  "duplicateStrategy": "<string>",
  "duplicateStrategyToken": "<string>",
  "listIds[]": [
    "<string>"
  ],
  "tagIds[]": [
    "<string>"
  ],
  "website": "<string>",
  "redirectUrl": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/forms/{companyId}"

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "customAttributes[fieldKey]": "<string>",
    "customAttributes": {},
    "duplicateStrategy": "<string>",
    "duplicateStrategyToken": "<string>",
    "listIds[]": ["<string>"],
    "tagIds[]": ["<string>"],
    "website": "<string>",
    "redirectUrl": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    firstName: '<string>',
    lastName: '<string>',
    phone: '<string>',
    'customAttributes[fieldKey]': '<string>',
    customAttributes: {},
    duplicateStrategy: '<string>',
    duplicateStrategyToken: '<string>',
    'listIds[]': ['<string>'],
    'tagIds[]': ['<string>'],
    website: '<string>',
    redirectUrl: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/forms/{companyId}', 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/forms/{companyId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'phone' => '<string>',
    'customAttributes[fieldKey]' => '<string>',
    'customAttributes' => [
        
    ],
    'duplicateStrategy' => '<string>',
    'duplicateStrategyToken' => '<string>',
    'listIds[]' => [
        '<string>'
    ],
    'tagIds[]' => [
        '<string>'
    ],
    'website' => '<string>',
    'redirectUrl' => '<string>'
  ]),
  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/forms/{companyId}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.sequenzy.com/api/v1/forms/{companyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"duplicateStrategy\": \"<string>\",\n  \"duplicateStrategyToken\": \"<string>\",\n  \"listIds[]\": [\n    \"<string>\"\n  ],\n  \"tagIds[]\": [\n    \"<string>\"\n  ],\n  \"website\": \"<string>\",\n  \"redirectUrl\": \"<string>\"\n}"

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

{"success": true}

Location: https://example.com/thank-you

{ "success": false, "message": "Please enter a valid email address" }

{
  "success": false,
  "message": "Please enter a valid redirect URL"
}

{ "success": false, "message": "This email address cannot be subscribed" }

{ "success": false, "message": "Invalid form configuration" }

{ "success": false, "message": "Too many requests. Please try again later." }

{ "success": false, "message": "An error occurred. Please try again." }

Overview

Companies

Sync Rules

Shopify

Websites

Integrations

Sender Profiles

Tracking Settings

Sending Status

Notification Preferences

Subscribers

Tags

Lists

Events

Segments

Audience Syncs

Migrations

Products

Media

Analytics

Sequences

Generation

SMS

Campaigns

Landing Pages

Emails

A/B Tests

Email Sends

Suppressions

Transactional

Templates

Widgets

Commerce

Webhooks

Team

Conversations

Submit Signup Form

Request

Responses

​Submit Signup Form

​Request

​Responses

Submit Signup Form

Request

Responses