Update List - Sequenzy

PATCH

api

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,
  "allowMemberUnsubscribe": true
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>",
    "isPrivate": True,
    "allowMemberUnsubscribe": 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,
    allowMemberUnsubscribe: 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,
    '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/{listId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": 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  \"allowMemberUnsubscribe\": 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  \"allowMemberUnsubscribe\": 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,
    "allowMemberUnsubscribe": 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 internal list description. It is never shown in hosted or embedded subscriber preferences. Pass null to clear it.

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 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,
    "allowMemberUnsubscribe": false,
    "createdAt": "2026-05-20T10:00:00.000Z"
  }
}

{
  "error": "Invalid API key"
}

{
  "error": "List not found"
}

{
  "error": "Failed to update 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.

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,
  "allowMemberUnsubscribe": true
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>",
    "isPrivate": True,
    "allowMemberUnsubscribe": 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,
    allowMemberUnsubscribe: 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,
    '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/{listId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isPrivate\": true,\n  \"allowMemberUnsubscribe\": 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  \"allowMemberUnsubscribe\": 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  \"allowMemberUnsubscribe\": 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,
    "allowMemberUnsubscribe": false,
    "createdAt": "2026-05-20T10:00:00.000Z"
  }
}

{
  "error": "Invalid API key"
}

{
  "error": "List not found"
}

{
  "error": "Failed to update list"
}

​Request

​Responses

Request

Responses