POST

api

forms

{formId}

Submit Saved Form

curl --request POST \
  --url https://api.sequenzy.com/api/v1/forms/{formId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "customAttributes[fieldKey]": "<string>",
  "customAttributes": {},
  "website": "<string>"
}
'

import requests

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

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "customAttributes[fieldKey]": "<string>",
    "customAttributes": {},
    "website": "<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: {},
    website: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/forms/{formId}', 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/{formId}",
  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' => [
        
    ],
    'website' => '<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/{formId}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"website\": \"<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/{formId}")
  .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  \"website\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"website\": \"<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": "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 Saved Form

You can submit a saved signup form created in the dashboard without an API key. The endpoint accepts application/x-www-form-urlencoded form posts and JSON. The form’s stored settings are the source of truth for audience targeting (lists, tags) and success behavior (success message or redirect URL). When you change those settings in the dashboard, deployed embeds pick them up automatically - no re-embedding needed. List, tag, and redirect values in the request are ignored.

Request

string

required

The saved form ID. You can find it in the form’s embed code on the Forms screen.

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 when the saved form includes a phone field. It is normalized onto the base subscriber profile without changing SMS consent.

string

Value for a custom field configured on the saved form. The fieldKey is stored as a subscriber custom attribute, for example customAttributes[nickname]=Ace.

object

JSON alternative for custom integrations. Saved forms only accept keys that are configured as custom fields on the form.

string

Honeypot field. Leave it empty.

Generated saved-form HTML renders built-in name fields first, then email, then configured custom fields before the submit button. Custom fields cannot currently be interleaved with built-in fields.

curl -X POST "https://api.sequenzy.com/api/v1/forms/form_abc123" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "email=user@example.com" \
  --data-urlencode "customAttributes[nickname]=Ace"

Existing company-scoped saved form submission URLs continue to work.

Responses

Native HTML form posts that accept text/html receive a hosted confirmation page that mirrors the form’s success screen (checkmark, heading, and message) instead of JSON. Forms configured to redirect respond with a 303 to the stored redirect URL.

{"success": true}

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

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

{ "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 Saved PopupSubmit a saved popup and create or update a subscriber.

Submit Saved Form

curl --request POST \
  --url https://api.sequenzy.com/api/v1/forms/{formId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "customAttributes[fieldKey]": "<string>",
  "customAttributes": {},
  "website": "<string>"
}
'

import requests

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

payload = {
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "customAttributes[fieldKey]": "<string>",
    "customAttributes": {},
    "website": "<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: {},
    website: '<string>'
  })
};

fetch('https://api.sequenzy.com/api/v1/forms/{formId}', 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/{formId}",
  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' => [
        
    ],
    'website' => '<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/{formId}"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"customAttributes[fieldKey]\": \"<string>\",\n  \"customAttributes\": {},\n  \"website\": \"<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/{formId}")
  .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  \"website\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"website\": \"<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": "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

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 Saved Form

Submit Saved Form

Request

Responses

​Submit Saved Form

​Request

​Responses

Submit Saved Form

Request

Responses