Add Tags to Subscriber
Add one or more tags to an existing subscriber
https://lumail.io/api/v1/subscribers/{subscriber}/tags
Add one or more tags to an existing subscriber. Tags that don't exist will be created automatically. If the subscriber already has a tag, it will be skipped (no duplicate tags).
Response
- Success (200 OK) - Returns the list of tags that were processed.
- Error (404 Not Found) - Subscriber not found.
- Error (400 Bad Request) - Invalid request body or empty tags array.
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the operation was successful |
added | number | Number of new tags added (excludes tags the subscriber already had) |
tags | array | List of all tags that were processed |
tags[].id | string | Unique identifier for the tag |
tags[].name | string | Name of the tag |
Request Schema
| Field | Type | Default | Description |
|---|---|---|---|
tags | string[] | required | Array of tag names to add to the subscriber. At least one tag is required. |
Path Parameters
| Parameter | Type | Description |
|---|---|---|
subscriber | string | Subscriber identifier - can be either the subscriber ID (e.g., sub_TTYPR5tWDh) or email address |
Usage Example
Use this API endpoint to:
- Add tags to subscribers for segmentation and targeting
- Automatically tag subscribers based on external events (purchases, signups, etc.)
- Sync tags from your CRM or other systems
- Trigger workflows based on tag additions
Related Documentation
- Get All Tags - List available tags
- Create Tags - Create new tags
- Remove Tags from Subscriber - Remove tags from subscribers
- Workflows - Trigger workflows when tags are added
- Action Step - Add tags within workflows
- Subscriber Events - View tag change history