Update Saved Form

PATCH

api

forms

{formId}

Update Saved Form

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/forms/{formId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "listIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "duplicateStrategy": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "buttonText": "<string>",
  "successMessage": "<string>",
  "redirectUrl": "<string>",
  "theme": {},
  "blocks": [
    {}
  ],
  "fieldType": "<string>",
  "mapsTo": "<string>",
  "label": "<string>",
  "placeholder": "<string>",
  "required": true,
  "defaultValue": "<string>",
  "showLabel": true,
  "width": "<string>",
  "options": [
    {}
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "listIds": ["<string>"],
    "tagIds": ["<string>"],
    "duplicateStrategy": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "buttonText": "<string>",
    "successMessage": "<string>",
    "redirectUrl": "<string>",
    "theme": {},
    "blocks": [{}],
    "fieldType": "<string>",
    "mapsTo": "<string>",
    "label": "<string>",
    "placeholder": "<string>",
    "required": True,
    "defaultValue": "<string>",
    "showLabel": True,
    "width": "<string>",
    "options": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    listIds: ['<string>'],
    tagIds: ['<string>'],
    duplicateStrategy: '<string>',
    headline: '<string>',
    description: '<string>',
    buttonText: '<string>',
    successMessage: '<string>',
    redirectUrl: '<string>',
    theme: {},
    blocks: [{}],
    fieldType: '<string>',
    mapsTo: '<string>',
    label: '<string>',
    placeholder: '<string>',
    required: true,
    defaultValue: '<string>',
    showLabel: true,
    width: '<string>',
    options: [{}]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'tagIds' => [
        '<string>'
    ],
    'duplicateStrategy' => '<string>',
    'headline' => '<string>',
    'description' => '<string>',
    'buttonText' => '<string>',
    'successMessage' => '<string>',
    'redirectUrl' => '<string>',
    'theme' => [
        
    ],
    'blocks' => [
        [
                
        ]
    ],
    'fieldType' => '<string>',
    'mapsTo' => '<string>',
    'label' => '<string>',
    'placeholder' => '<string>',
    'required' => true,
    'defaultValue' => '<string>',
    'showLabel' => true,
    'width' => '<string>',
    'options' => [
        [
                
        ]
    ]
  ]),
  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  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sequenzy.com/api/v1/forms/{formId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\n}"

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

{
  "success": true,
  "form": {
    "id": "form_123",
    "name": "Blog newsletter",
    "status": "published",
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123"
  },
  "embed": {
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123",
    "scriptUrl": "https://api.sequenzy.com/api/v1/forms/form_123/embed.js"
  },
  "message": "Form updated."
}

{ "error": "blocks: Forms must contain exactly one email field." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Form not found" }

{ "error": "Failed to update form." }

Update an existing saved form. Every field is optional - send only what should change. Use this to retarget the audience, edit copy, restyle the form to match your brand, or replace the content blocks (for example to remove blocks you no longer want rendered publicly).

Request

string

required

Saved form ID.

string

New internal form name.

string[]

Replacement list targeting. Every submission joins these lists.

string[]

Replacement tag IDs. Pass an empty array to clear tags.

string

skip, merge, or overwrite.

string

New text for the form’s first heading block. Fails if the form has no heading block - edit blocks instead.

string

New text for the form’s first paragraph block. Fails if the form has no paragraph block - edit blocks instead.

string

New submit button label.

string

New confirmation message on the success screen.

string

HTTP or HTTPS success redirect. Pass an empty string to switch back to the confirmation message.

object

Visual overrides merged into the current theme. Any subset of accentColor, backgroundColor, textColor, mutedTextColor, cardColor, borderColor (all #rrggbb), borderRadius (0-32), headingFontFamily, bodyFontFamily, and density (compact | balanced | spacious).

object[]

Full replacement for the form’s content blocks. Read the current blocks with GET /api/v1/forms, modify them, and send the complete array. The form must keep exactly one required email field and one submit button. See Content blocks below.

curl -X PATCH "https://api.sequenzy.com/api/v1/forms/form_123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "buttonText": "Get the planner",
    "theme": { "accentColor": "#0f766e" }
  }'

Content blocks

Blocks render in array order. Every block needs a unique id and a kind. Content blocks (heading, text, image, button, divider, spacer, custom-html, feature-grid, testimonial, countdown) may also set sectionId to "success" or "error" to render inside that screen; input blocks, the submit button, and the success and error blocks always belong to the form itself. Available kinds: form-field, form-step, submit-button, success-screen, error-state, plus the content kinds above.

Form field blocks

kind: "form-field" renders one input. Fields that are not mapped to a built-in subscriber property are stored as subscriber custom attributes keyed by the block’s name.

string

default:"text"

text, email, phone, number, textarea, select, radio, checkbox, consent, or hidden.

string

required

The submitted key, and the custom attribute key when mapsTo is customAttribute. Must start with a letter and may contain letters, digits, _, ., and -. Field names must be unique within a form.

string

default:"customAttribute"

email, firstName, lastName, phone, or customAttribute. The email field must use fieldType: "email" and required: true; first and last name fields must use fieldType: "text"; a mapped phone field must use fieldType: "phone". A form may contain at most one field per built-in target.

string

Accessible name, also shown above the input unless showLabel is false.

string

Placeholder text. Also used as the empty option’s label on select.

boolean

default:"false"

Whether submissions without a value are rejected.

string

Pre-filled value. On a hidden field this is the server-owned value (see below).

boolean

default:"true"

Whether the label renders above the input.

string

full or half. Adjacent half fields pair side by side and stack on mobile.

object[]

Required for select, radio, and checkbox: [{ "value": "pro", "label": "Pro", "id": "pro" }]. Only value is required - label and id default to value. Values and ids must be unique within the field, and submissions outside the option values are rejected. A checkbox field stores an array of the selected values.

Hidden fields

A hidden field with a non-empty defaultValue always stores that server-owned value and ignores whatever the page posts, which is how you stamp a constant such as a form source. A hidden field with an empty defaultValue stores the value the page submits, which is how you pass machine-filled data such as UTM parameters or a page URL. A required hidden field must have a defaultValue.

Example

{
  "blocks": [
    {
      "id": "field-email",
      "kind": "form-field",
      "fieldType": "email",
      "name": "email",
      "label": "Email",
      "required": true,
      "mapsTo": "email"
    },
    {
      "id": "field-plan",
      "kind": "form-field",
      "fieldType": "select",
      "name": "plan",
      "label": "Plan",
      "placeholder": "Choose a plan",
      "mapsTo": "customAttribute",
      "options": [{ "value": "starter" }, { "value": "pro" }]
    },
    {
      "id": "field-utm-source",
      "kind": "form-field",
      "fieldType": "hidden",
      "name": "utm_source",
      "mapsTo": "customAttribute"
    },
    { "id": "submit", "kind": "submit-button", "text": "Subscribe" }
  ]
}

Validation failures name the offending property, for example blocks[1].options[0].value: Too small: expected string to have >=1 characters.

Responses

{
  "success": true,
  "form": {
    "id": "form_123",
    "name": "Blog newsletter",
    "status": "published",
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123"
  },
  "embed": {
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123",
    "scriptUrl": "https://api.sequenzy.com/api/v1/forms/form_123/embed.js"
  },
  "message": "Form updated."
}

{ "error": "blocks: Forms must contain exactly one email field." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Form not found" }

{ "error": "Failed to update form." }

Update Saved Form

curl --request PATCH \
  --url https://api.sequenzy.com/api/v1/forms/{formId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "listIds": [
    "<string>"
  ],
  "tagIds": [
    "<string>"
  ],
  "duplicateStrategy": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "buttonText": "<string>",
  "successMessage": "<string>",
  "redirectUrl": "<string>",
  "theme": {},
  "blocks": [
    {}
  ],
  "fieldType": "<string>",
  "mapsTo": "<string>",
  "label": "<string>",
  "placeholder": "<string>",
  "required": true,
  "defaultValue": "<string>",
  "showLabel": true,
  "width": "<string>",
  "options": [
    {}
  ]
}
'

import requests

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

payload = {
    "name": "<string>",
    "listIds": ["<string>"],
    "tagIds": ["<string>"],
    "duplicateStrategy": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "buttonText": "<string>",
    "successMessage": "<string>",
    "redirectUrl": "<string>",
    "theme": {},
    "blocks": [{}],
    "fieldType": "<string>",
    "mapsTo": "<string>",
    "label": "<string>",
    "placeholder": "<string>",
    "required": True,
    "defaultValue": "<string>",
    "showLabel": True,
    "width": "<string>",
    "options": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    listIds: ['<string>'],
    tagIds: ['<string>'],
    duplicateStrategy: '<string>',
    headline: '<string>',
    description: '<string>',
    buttonText: '<string>',
    successMessage: '<string>',
    redirectUrl: '<string>',
    theme: {},
    blocks: [{}],
    fieldType: '<string>',
    mapsTo: '<string>',
    label: '<string>',
    placeholder: '<string>',
    required: true,
    defaultValue: '<string>',
    showLabel: true,
    width: '<string>',
    options: [{}]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'listIds' => [
        '<string>'
    ],
    'tagIds' => [
        '<string>'
    ],
    'duplicateStrategy' => '<string>',
    'headline' => '<string>',
    'description' => '<string>',
    'buttonText' => '<string>',
    'successMessage' => '<string>',
    'redirectUrl' => '<string>',
    'theme' => [
        
    ],
    'blocks' => [
        [
                
        ]
    ],
    'fieldType' => '<string>',
    'mapsTo' => '<string>',
    'label' => '<string>',
    'placeholder' => '<string>',
    'required' => true,
    'defaultValue' => '<string>',
    'showLabel' => true,
    'width' => '<string>',
    'options' => [
        [
                
        ]
    ]
  ]),
  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  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sequenzy.com/api/v1/forms/{formId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"tagIds\": [\n    \"<string>\"\n  ],\n  \"duplicateStrategy\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"redirectUrl\": \"<string>\",\n  \"theme\": {},\n  \"blocks\": [\n    {}\n  ],\n  \"fieldType\": \"<string>\",\n  \"mapsTo\": \"<string>\",\n  \"label\": \"<string>\",\n  \"placeholder\": \"<string>\",\n  \"required\": true,\n  \"defaultValue\": \"<string>\",\n  \"showLabel\": true,\n  \"width\": \"<string>\",\n  \"options\": [\n    {}\n  ]\n}"

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

{
  "success": true,
  "form": {
    "id": "form_123",
    "name": "Blog newsletter",
    "status": "published",
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123"
  },
  "embed": {
    "actionUrl": "https://api.sequenzy.com/api/v1/forms/form_123",
    "scriptUrl": "https://api.sequenzy.com/api/v1/forms/form_123/embed.js"
  },
  "message": "Form updated."
}

{ "error": "blocks: Forms must contain exactly one email field." }

{
  "error": "Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"
}

{ "error": "API key is missing required scope: widgets:write" }

{ "error": "Form not found" }

{ "error": "Failed to update form." }

​Request

​Content blocks

​Form field blocks

​Hidden fields

​Example

​Responses

Request

Content blocks

Form field blocks

Hidden fields

Example

Responses