Remove Tags from Subscriber
Remove one or more tags from an existing subscriber
https://lumail.io/api/v1/subscribers/{subscriber}/tags
Remove one or more tags from an existing subscriber. Tags that don't exist or that the subscriber doesn't have will be ignored.
Response
- Success (200 OK) - Returns the list of tags that were actually removed.
- 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 |
removed | number | Number of tags actually removed from the subscriber |
tags | array | List of tags that were removed |
tags[].id | string | Unique identifier for the tag |
tags[].name | string | Name of the tag |
message | string | (Optional) Additional information when no tags were removed |
Request Schema
| Field | Type | Default | Description |
|---|---|---|---|
tags | string[] | required | Array of tag names to remove from 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:
- Remove tags from subscribers when they no longer qualify for a segment
- Sync tag removals from your CRM or other systems
- Clean up subscriber data by removing obsolete tags
- Manage subscriber preferences and opt-outs
Related Documentation
- Get All Tags - List available tags
- Add Tags to Subscriber - Add tags to subscribers
- Action Step - Remove tags within workflows
- Subscriber Events - View tag removal history