Bulk Unsubscribe Variables

Unsubscribes up to 10,000 variables in a single request.

POST /v2/unsubscribes/variables

Bulk Unsubscribe Variables

cURL

curl --request POST \
  --url https://api.lemlist.com/api/v2/unsubscribes/variables \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "values": [
    "[e-mail]",
    "@example.org",
    "[phone]"
  ]
}
'

import requests

url = "https://api.lemlist.com/api/v2/unsubscribes/variables"

payload = { "values": ["[e-mail]", "@example.org", "[phone]"] }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({values: ['[e-mail]', '@example.org', '[phone]']})
};

fetch('https://api.lemlist.com/api/v2/unsubscribes/variables', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/v2/unsubscribes/variables")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"values\": [\n    \"[e-mail]\",\n    \"@example.org\",\n    \"[phone]\"\n  ]\n}"

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/v2/unsubscribes/variables",
  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([
    'values' => [
        '[e-mail]',
        '@example.org',
        '[phone]'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

"Variables unsubscribed"

"Maximum 10000 values allowed"

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

values · string[] · required

List of variables to unsubscribe (emails, domains, LinkedIn URLs, or phone numbers). Maximum 10,000 values.

Maximum array length: 10000

Response

200

application/json

Success