Update Subscriber

Patch name, fields, or tags on a contact.

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",
  "status": "SUBSCRIBED"
}

Patch a contact. :subscriber is an id or email. Delete stays disabled; use Unsubscribe. Permission: subscribers.

Omitted resubscribe does not re-subscribe an unsubscribed contact. Optional skipDoubleOptIn: true promotes PENDING_CONFIRMATION to SUBSCRIBED before tag events.

Path Parameters

Name	Type	Description
`subscriber`	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<string, string \| null>`	Custom field values.
`replaceTags`	boolean	When `true`, replace existing tags with `tags`.
`resubscribe`	boolean	Re-subscribe an `UNSUBSCRIBED` contact.
`triggerWorkflows`	boolean	Fire tag / field workflows.
`skipDoubleOptIn`	boolean	Promote `PENDING_CONFIRMATION` to `SUBSCRIBED`.
`ipAddress`	string	Client IP stored as evidence.
`country`	string	ISO 3166-1 alpha-2 country code.

Response Fields

Field	Type	Description
`id`	string	Subscriber id.
`email`	string	Email address.
`name`	string or null	Display name.
`phone`	string or null	Phone number.
`status`	string	Current status.
`tags`	`{ id, name }[]`	Current audience tags.
`fields`	object	Custom fields.
`warnings`	string[]	Present when some tags or fields could not be applied.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `subscribers` permission
404	`not_found`	Unknown id or email
422	`validation_error`	Invalid payload

PreviousGet Subscriber NextUnsubscribe Subscriber

Path Parameters

Body Parameters

Response Fields

Errors

Related