Marketing · Subscriptions

Bulk globally unsubscribe a list with the Marketing API

Globally opts out every subscriber in a subscription list without having to enumerate them.

This endpoint has two modes:

Explicit — supply subscriber_ids and the request behaves exactly like POST /subscriptions/unsubscribe, returning the affected subscribers synchronously.
Select-all — omit subscriber_ids and supply from_subscription_list_id. Every subscriber matching search and filters in that list, minus except_ids, is queued for processing in the background and a Sidekiq job ID (jid) is returned immediately.

In select-all mode from_subscription_list_id is required and must be a subscription list UUID. Globally opting a subscriber out suppresses all future marketing email to them, across every list.

POST

subscriptions

bulk_global_unsubscribe

Bulk global unsubscribe

curl --request POST \
  --url https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "from_subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "search": "*",
  "except_ids": [
    "8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60"
  ]
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe"

payload = {
    "from_subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
    "search": "*",
    "except_ids": ["8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60"]
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from_subscription_list_id: '123e4567-e89b-12d3-a456-426614174000',
    search: '*',
    except_ids: ['8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60']
  })
};

fetch('https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe', 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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe",
  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([
    'from_subscription_list_id' => '123e4567-e89b-12d3-a456-426614174000',
    'search' => '*',
    'except_ids' => [
        '8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe"

	payload := strings.NewReader("{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}"

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

{
  "data": {
    "jid": "<string>"
  },
  "errors": "<string>"
}

{
  "errors": [
    {
      "message": "401 Unauthorized"
    }
  ]
}

{
  "errors": [
    {
      "message": "401 Unauthorized"
    }
  ]
}

Authorizations

authorization

string

header

required

Token-based authentication. Use format: "Token token=YOUR_API_KEY" where YOUR_API_KEY is your API key

Body

application/json

subscriber_ids

string[]

UUIDs of specific subscribers to update. When present the request is handled synchronously and every other field is ignored.

from_subscription_list_id

string

UUID of the list whose members are being updated. Required when subscriber_ids is omitted. On the bulk_global_* endpoints this is a subscription list UUID; on the dynamic_bulk_* endpoints it is a dynamic list UUID.

string

Search term used to narrow the list's members. Defaults to * (all members) on the bulk_global_* endpoints.

filters

string

URL-encoded JSON describing additional subscriber filters, as generated by the subscriber search in the Marketing dashboard. The decoded value is an array of filter groups, each group an array of {"field": ..., "op": ..., "terms": [...]} objects. Ignored by the dynamic_bulk_* endpoints, which use the filters saved on the dynamic list.

except_ids

string[]

UUIDs of subscribers to exclude from the operation. Use this to express "select all except these".

Response

A job ID in select-all mode, or the affected subscribers when subscriber_ids was supplied.

data

object

object
object[]

Show child attributes

errors

string

Error message, present only when the operation failed

⌘I

Bulk global unsubscribe

curl --request POST \
  --url https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --data '
{
  "from_subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "search": "*",
  "except_ids": [
    "8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60"
  ]
}
'

import requests

url = "https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe"

payload = {
    "from_subscription_list_id": "123e4567-e89b-12d3-a456-426614174000",
    "search": "*",
    "except_ids": ["8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60"]
}
headers = {
    "authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from_subscription_list_id: '123e4567-e89b-12d3-a456-426614174000',
    search: '*',
    except_ids: ['8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60']
  })
};

fetch('https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe', 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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe",
  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([
    'from_subscription_list_id' => '123e4567-e89b-12d3-a456-426614174000',
    'search' => '*',
    'except_ids' => [
        '8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "authorization: <api-key>"
  ],
]);

$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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe"

	payload := strings.NewReader("{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("authorization", "<api-key>")
	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.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe")
  .header("authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/marketing/subscriptions/bulk_global_unsubscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from_subscription_list_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n  \"search\": \"*\",\n  \"except_ids\": [\n    \"8f14e45f-ceea-467a-9f2c-4b3d2a1e5c60\"\n  ]\n}"

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

{
  "data": {
    "jid": "<string>"
  },
  "errors": "<string>"
}

{
  "errors": [
    {
      "message": "401 Unauthorized"
    }
  ]
}

{
  "errors": [
    {
      "message": "401 Unauthorized"
    }
  ]
}

Email API · Messages

Email API · Scheduled Send

Email API · Receiving

Email API · Webhooks

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscriptions

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Bulk globally unsubscribe a list with the Marketing API

Authorizations

Body

Response