lumail.subscribers.update

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

MethodPATCH

/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.update(
  "[email protected]",
  { name: "Ada Lovelace" },
);
if (error) {
  throw error;
}
console.log(data.name);

Response Examples

{
  "id": "sub_abc123",
  "email": "[email protected]",
  "name": "Ada Lovelace",
  "phone": null,
  "status": "SUBSCRIBED",
  "tags": [],
  "fields": {}
}

[email protected] · lumail.subscribers

subscribers.update(idOrEmail: string, params: UpdateSubscriberParams): Promise<LumailResult<UpdateSubscriberResponse>>

Patch name, fields, tags. Optional replaceTags, resubscribe, triggerWorkflows, skipDoubleOptIn.

skipDoubleOptIn: true promotes an existing PENDING_CONFIRMATION contact to SUBSCRIBED before tag events. It does not resubscribe UNSUBSCRIBED unless resubscribe is also true.

Path Parameters

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

Body Parameters

Name	Type	Description
`email`	string	New email address.
`name`	string or null	Display name.
`phone`	string or null	Phone number.
`tags`	string[]	Tag names to attach.
`fields`	`Record`	Custom fields. `null` clears a field.
`replaceTags`	boolean	When `true`, replace the existing tag set with `tags`.
`resubscribe`	boolean	When `true`, re-subscribe an `UNSUBSCRIBED` contact. Omitted `resubscribe` does not re-subscribe.
`triggerWorkflows`	boolean	When `true`, run subscribe workflows.
`skipDoubleOptIn`	boolean	When `true`, promote `PENDING_CONFIRMATION` to `SUBSCRIBED` before tag events.
`ipAddress`	string	Optional signup IP.
`country`	string	Optional country code.

Response Fields

Field	Type	Description
`id`	string	Subscriber id.
`email`	string	Email.
`name`	string or null	Display name.
`phone`	string or null	Phone.
`status`	`SubscriberStatus`	Current status.
`tags`	`{ id, name }[]`	Attached tags.
`fields`	`Record`	Custom fields.
`createdAt`	string	Optional ISO 8601 timestamp.
`updatedAt`	string	Optional ISO 8601 timestamp.
`warnings`	string[]	Optional non-fatal notes.

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

Previouslumail.subscribers.get Nextlumail.subscribers.delete