Lists
Remove Subscribers from List
Remove subscribers from a subscriber list
POST
/
api
/
v1
/
lists
/
{listId}
/
subscribers
/
remove
Remove Subscribers from List
curl --request POST \
--url https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emails": [
"<string>"
],
"subscriberIds": [
"<string>"
]
}
'import requests
url = "https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove"
payload = {
"emails": ["<string>"],
"subscriberIds": ["<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({emails: ['<string>'], subscriberIds: ['<string>']})
};
fetch('https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove', 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}/subscribers/remove",
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([
'emails' => [
'<string>'
],
'subscriberIds' => [
'<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/lists/{listId}/subscribers/remove"
payload := strings.NewReader("{\n \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\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/{listId}/subscribers/remove")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove")
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 \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"removed": 1,
"notFound": ["unknown@example.com"]
}
{
"error": "Provide emails or subscriberIds"
}
{
"error": "A maximum of 500 subscribers can be removed per request"
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}
Remove subscribers from one list by email or subscriber ID. Subscribers are not deleted, they only lose the list membership. You can pass up to 500 targets per request, combined across
Provide at least one of
emails and subscriberIds.
Permissions
This endpoint needs bothlists:write and subscribers:write, the same pair as
Add Subscribers To List. Membership is
contact state, so lists:write on its own only lets a key create and rename
lists. The Safer agent access preset includes lists:write but not
subscribers:write, so keys on that preset cannot change who is in a list.
Request
string
required
Subscriber list ID.
string[]
Email addresses to remove. Emails are trimmed and lowercased. Unknown emails
are returned in
notFound.string[]
Subscriber IDs to remove.
emails or subscriberIds.
curl -X POST "https://api.sequenzy.com/api/v1/lists/list_abc123/subscribers/remove" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"emails": ["user@example.com", "unknown@example.com"]}'
Responses
{
"success": true,
"removed": 1,
"notFound": ["unknown@example.com"]
}
{
"error": "Provide emails or subscriberIds"
}
{
"error": "A maximum of 500 subscribers can be removed per request"
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}
⌘I
Remove Subscribers from List
curl --request POST \
--url https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emails": [
"<string>"
],
"subscriberIds": [
"<string>"
]
}
'import requests
url = "https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove"
payload = {
"emails": ["<string>"],
"subscriberIds": ["<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({emails: ['<string>'], subscriberIds: ['<string>']})
};
fetch('https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove', 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}/subscribers/remove",
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([
'emails' => [
'<string>'
],
'subscriberIds' => [
'<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/lists/{listId}/subscribers/remove"
payload := strings.NewReader("{\n \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\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/{listId}/subscribers/remove")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/lists/{listId}/subscribers/remove")
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 \"emails\": [\n \"<string>\"\n ],\n \"subscriberIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"removed": 1,
"notFound": ["unknown@example.com"]
}
{
"error": "Provide emails or subscriberIds"
}
{
"error": "A maximum of 500 subscribers can be removed per request"
}
{
"error": "Invalid API key"
}
{
"error": "List not found"
}