lumail.subscribers.delete

SDK 2.1.0 · API v2 · DELETE /api/v2/subscribers/:subscriber

MethodDELETE

/api/v2/subscribers/:subscriber

Request Examples

import { Lumail } from "lumail";

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

Response Examples

{
  "object": "subscriber",
  "id": "sub_abc123",
  "deleted": true
}

[email protected] · lumail.subscribers

subscribers.delete(idOrEmail: string): Promise<LumailResult<DeleteSubscriberResponse>>

Disabled, same policy as v1. The server returns 422. Use unsubscribe.

Path Parameters

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

Response Fields

Field	Type	Description
`object`	string	Resource name. Typed as `"subscriber"` if delete ever succeeds.
`id`	string	Subscriber id.
`deleted`	`true`	Always `true` on the typed success shape.

This method does not delete the contact. error is { name: "validation_error", message, statusCode: 422 }.

Previouslumail.subscribers.update Nextlumail.subscribers.unsubscribe