Update Subscriber

https://lumail.io/api/v1/subscribers/{subscriber}

Updates an existing subscriber by ID or email address. You can modify their details, custom fields, and assigned tags.

Response

• Success (200 OK) - Returns the updated subscriber object.
• Error (404 Not Found) - Returned if the subscriber does not exist.

Response Fields

Field	Type	Description
success	boolean	Indicates if the operation was successful
subscriber	object	The updated subscriber object
subscriber.id	string	Unique identifier for the subscriber
subscriber.email	string	Email address of the subscriber
subscriber.name	string or null	Name of the subscriber (if provided)
subscriber.phone	string or null	Phone number of the subscriber (if provided)
subscriber.status	string	Current status of the subscriber
subscriber.tags	array	Array of tag objects associated with the subscriber
subscriber.tags[].id	string	Unique identifier for the tag
subscriber.tags[].name	string	Name of the tag
subscriber.fields	object	Custom field values associated with this subscriber

Request Schema

Field	Type	Default	Description
email	string	required	Email address of the subscriber
name	string	optional	Name of the subscriber
phone	string	optional	Phone number of the subscriber
tags	string[]	[]	Tag names to add to the subscriber
fields	object	optional	Custom field values (key-value pairs)
replaceTags	boolean	false	If true, replaces all existing tags with the provided ones
resubscribe	boolean	false	If true, resubscribes the user if they were previously unsubscribed. By default, unsubscribed users stay unsubscribed
triggerWorkflows	boolean	true	If false, skip triggering workflows even if subscriber's tags match workflow triggers. Useful for bulk updates or syncing data without triggering automations

Usage Example

Use this API endpoint to update subscriber information such as:

• Update a subscriber's name or contact details
• Add or remove tags to change subscriber categorization
• Update custom field values for personalization or segmentation
• Modify subscriber information after form submissions or user profile updates
• Sync subscriber data between different systems

Related Documentation

• Add Tags to Subscriber - Add tags to subscribers
• Remove Tags from Subscriber - Remove tags from subscribers
• Workflows - Control workflow triggering with triggerWorkflows
• Dynamic Promo Codes - Update subscribers with webhook responses
• Subscriber Events - View field update history