Remove Tags from Subscriber

Remove one or more tags from an existing subscriber

MethodDELETE
/api/v1/subscribers/{subscriber}/tags

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

FieldTypeDescription
successbooleanIndicates if the operation was successful
removednumberNumber of tags actually removed from the subscriber
tagsarrayList of tags that were removed
tags[].idstringUnique identifier for the tag
tags[].namestringName of the tag
messagestring(Optional) Additional information when no tags were removed

Request Schema

FieldTypeDefaultDescription
tagsstring[]requiredArray of tag names to remove from the subscriber. At least one tag is required.

Path Parameters

ParameterTypeDescription
subscriberstringSubscriber 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