lumail.subscribers.unsubscribe

SDK 2.1.0 · API v2 · POST /api/v2/subscribers/:subscriber/unsubscribe

MethodPOST

/api/v2/subscribers/:subscriber/unsubscribe

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.subscribers.unsubscribe(
  "[email protected]",
);
if (error) {
  throw error;
}
console.log(data.status ?? data.message);

Response Examples

{
  "id": "sub_abc123",
  "email": "[email protected]",
  "status": "UNSUBSCRIBED",
  "message": "Subscriber unsubscribed successfully"
}

[email protected] · lumail.subscribers

subscribers.unsubscribe(idOrEmail: string): Promise<LumailResult<UnsubscribeResponse>>

Marks the contact unsubscribed.

Path Parameters

Name	Type	Description
`idOrEmail`	string	Required. Subscriber id or email.

Response Fields

Field	Type	Description
`id`	string	Subscriber id when returned.
`email`	string	Email when returned.
`status`	`SubscriberStatus`	Usually `UNSUBSCRIBED`.
`message`	string	Human-readable confirmation.

data is the unsubscribe payload. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.subscribers.delete Nextlumail.subscribers.addTags