Unsubscribe a Subscriber by Email
Silently unsubscribe a subscriber from a specific list by using their email address. No email notification will be sent.
📧 Unsubscribe a Subscriber by Email
Locate a subscriber via email and unsubscribe them from the list silently.
🔹 HTTP Requests
Step 1: Search by email
GET API-URL/lists/LIST-UNIQUE-ID/subscribers/search-by-email
Step 2: Unsubscribe by subscriber UID
PUT API-URL/lists/LIST-UNIQUE-ID/subscribers/SUBSCRIBER-UNIQUE-ID/unsubscribe
🔸 URL Segments
Segment
Required
Description
LIST-UNIQUE-ID
Yes
List unique ID to which the subscriber belongs.
SUBSCRIBER-UNIQUE-ID
Yes
Subscriber unique ID to unsubscribe.
🔎 Query Parameters
Parameter
Required
Description
EMAIL
Yes
Email address of the subscriber.
🔐 Authorization Header
X-API-KEY: your-api-key-here
💻 PHP Example
// UNSUBSCRIBE existing subscriber by email address, no email is sent, unsubscribe is silent
$response = $endpoint->unsubscribeByEmail('LIST-UNIQUE-ID', '[email protected]');
// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';
📦 Sample JSON Response
{
"status": "success"
}
Last updated