lumail.subscribers.removeTags

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

MethodDELETE

/api/v2/subscribers/:subscriber/tags

Request Examples

import { Lumail } from "lumail";

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

Response Examples

{
  "removed": 1,
  "tags": [{ "id": "tag_abc", "name": "newsletter" }],
  "message": "Tags removed"
}

[email protected] · lumail.subscribers

subscribers.removeTags(idOrEmail: string, tags: string[]): Promise<LumailResult<RemoveTagsResponse>>

Detach tags. The SDK sends tags as a JSON-string query param.

Path Parameters

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

Query Parameters

Name	Type	Description
`tags`	string[]	Required. Second argument. Tag names to detach. Serialized as `?tags=`.

Response Fields

Field	Type	Description
`removed`	number	Count of tags detached.
`tags`	`{ id, name }[]`	Remaining tags when returned.
`message`	string	Optional confirmation.

data is { removed?, tags?, message? }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.subscribers.addTags Nextlumail.subscribers.listEvents