Create Subscriber List

POST

api

lists

curl --request POST \
  --url https://api.sequenzy.com/api/v1/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isPrivate": true,
  "allowMemberUnsubscribe": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/lists"

payload = {
    "name": "<string>",
    "description": "<string>",
    "isPrivate": True,
    "allowMemberUnsubscribe": True
}
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({
    name: '<string>',
    description: '<string>',
    isPrivate: true,
    allowMemberUnsubscribe: true
  })
};

fetch('https://api.sequenzy.com/api/v1/lists', 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/lists",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'isPrivate' => true,
    'allowMemberUnsubscribe' => true
  ]),
  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/lists"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\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/lists")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/lists")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\n}"

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

{
  "success": true,
  "list": {
    "id": "list_abc123",
    "name": "VIP Customers",
    "description": "High-value customers",
    "allowMemberUnsubscribe": false,
    "isPrivate": false
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Failed to create list"
}

Create a subscriber list for grouping contacts.

Request

string

required

List name.

string

Optional internal list description. It is visible to workspace members through authenticated list-management surfaces, but never appears in hosted or embedded subscriber preferences.

boolean

Private lists stay hidden from subscriber preferences unless you enable member unsubscribe. Public lists can be discovered and joined there. Descriptions always stay internal. Omission defaults to public on creation and preserves visibility on update.

boolean

Allow existing members of a private list to see its name and unsubscribe in email preferences. Defaults to false on creation. On update, omit to preserve the setting or pass false to disable it; null is rejected. The setting is stored but has no effect on public lists. Members cannot join or rejoin private lists through preferences.

curl -X POST "https://api.sequenzy.com/api/v1/lists" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "VIP Customers", "description": "High-value customers"}'

Responses

{
  "success": true,
  "list": {
    "id": "list_abc123",
    "name": "VIP Customers",
    "description": "High-value customers",
    "allowMemberUnsubscribe": false,
    "isPrivate": false
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Failed to create list"
}

The response includes allowMemberUnsubscribe. Updates that set the same value can be safely retried; creating a list again creates another list, so inspect your lists after an uncertain creation response. A non-boolean or null value for allowMemberUnsubscribe returns HTTP 422 without applying the change. Existing authentication and list-write permissions still apply.

Create Subscriber List

curl --request POST \
  --url https://api.sequenzy.com/api/v1/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isPrivate": true,
  "allowMemberUnsubscribe": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/lists"

payload = {
    "name": "<string>",
    "description": "<string>",
    "isPrivate": True,
    "allowMemberUnsubscribe": True
}
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({
    name: '<string>',
    description: '<string>',
    isPrivate: true,
    allowMemberUnsubscribe: true
  })
};

fetch('https://api.sequenzy.com/api/v1/lists', 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/lists",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'isPrivate' => true,
    'allowMemberUnsubscribe' => true
  ]),
  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/lists"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\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/lists")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/lists")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": true\n}"

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

{
  "success": true,
  "list": {
    "id": "list_abc123",
    "name": "VIP Customers",
    "description": "High-value customers",
    "allowMemberUnsubscribe": false,
    "isPrivate": false
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "Failed to create list"
}

​Request

​Responses

Request

Responses