Lists
Update List
Update a subscriber list
PATCH
/
api
/
v1
/
lists
/
{listId}
Update List
curl --request PATCH \
--url https://api.sequenzy.com/api/v1/lists/{listId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"isPrivate": true
}
'import requests
url = "https://api.sequenzy.com/api/v1/lists/{listId}"
payload = {
"name": "<string>",
"description": "<string>",
"isPrivate": True
}
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>', description: '<string>', isPrivate: true})
};
fetch('https://api.sequenzy.com/api/v1/lists/{listId}', 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/{listId}",
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>',
'description' => '<string>',
'isPrivate' => 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/{listId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isPrivate\": true\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/lists/{listId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isPrivate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/lists/{listId}")
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 \"description\": \"<string>\",\n \"isPrivate\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"list": {
"id": "list_abc123",
"name": "Newsletter Subscribers",
"description": "Weekly newsletter audience",
"isPrivate": false,
"createdAt": "2026-05-20T10:00:00.000Z"
}
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}
{
"error": "Failed to update list"
}
Update a subscriber list’s name, description, or privacy flag. Only the fields you provide are changed.
Request
string
required
Subscriber list ID.
string
New list name.
string
New list description. Pass
null to clear it.boolean
Set to
true to keep the list internal. Private lists are omitted from the
hosted subscriber email preferences/unsubscribe page and cannot be subscribed
to or unsubscribed from individually there. Set to false to expose the
list’s name and description on that page. List privacy does not override a
subscriber’s global unsubscribe. Omit this field to leave the current
visibility unchanged.curl -X PATCH "https://api.sequenzy.com/api/v1/lists/list_abc123" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Newsletter Subscribers", "isPrivate": false}'
Responses
{
"success": true,
"list": {
"id": "list_abc123",
"name": "Newsletter Subscribers",
"description": "Weekly newsletter audience",
"isPrivate": false,
"createdAt": "2026-05-20T10:00:00.000Z"
}
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}
{
"error": "Failed to update list"
}
⌘I
Update List
curl --request PATCH \
--url https://api.sequenzy.com/api/v1/lists/{listId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"isPrivate": true
}
'import requests
url = "https://api.sequenzy.com/api/v1/lists/{listId}"
payload = {
"name": "<string>",
"description": "<string>",
"isPrivate": True
}
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>', description: '<string>', isPrivate: true})
};
fetch('https://api.sequenzy.com/api/v1/lists/{listId}', 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/{listId}",
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>',
'description' => '<string>',
'isPrivate' => 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/{listId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isPrivate\": true\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/lists/{listId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isPrivate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/lists/{listId}")
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 \"description\": \"<string>\",\n \"isPrivate\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"list": {
"id": "list_abc123",
"name": "Newsletter Subscribers",
"description": "Weekly newsletter audience",
"isPrivate": false,
"createdAt": "2026-05-20T10:00:00.000Z"
}
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}
{
"error": "Failed to update list"
}