Groups

Organize subscribers into segments

GET
/api/v1/groups

List all subscriber groups

GET
/api/v1/groups/:id

Get a specific group with subscriber count

POST
/api/v1/groups

Create a new subscriber group

Example Request

{
  "name": "VIP Customers",
  "description": "High-value customers with premium access"
}
PATCH
/api/v1/groups/:id

Update a group

Example Request

{
  "name": "Updated Group Name",
  "description": "Updated description"
}
DELETE
/api/v1/groups/:id

Delete a group

⚠️ Note: Subscribers in this group will NOT be deleted, only the group association.

Managing Group Membership

POST
/api/v1/groups/:id/subscribers

Add subscribers to a group

{
  "subscriberIds": ["sub-uuid-1", "sub-uuid-2"]
}
DELETE
/api/v1/groups/:id/subscribers

Remove subscribers from a group

{
  "subscriberIds": ["sub-uuid-1", "sub-uuid-2"]
}