lumail.subscribers.addTags

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

MethodPOST

/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.addTags(
  "[email protected]",
  ["vip"],
);
if (error) {
  throw error;
}
console.log(data.added ?? data.tags);

Response Examples

{
  "added": 1,
  "tags": [{ "id": "tag_abc", "name": "vip" }]
}

[email protected] · lumail.subscribers

subscribers.addTags(idOrEmail: string, tags: string[]): Promise<LumailResult<AddTagsResponse>>

Attach tags without replacing the rest.

Path Parameters

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

Body Parameters

Name	Type	Description
`tags`	string[]	Required. Second argument. Tag names to attach. Sent as `{ tags }`.

Response Fields

Field	Type	Description
`added`	number	Count of tags attached.
`tags`	`{ id, name }[]`	Resulting or added tags.

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

Previouslumail.subscribers.unsubscribe Nextlumail.subscribers.removeTags