Campaigns

Create and manage email campaigns

GET
/api/v1/campaigns

List all campaigns

Query Parameters

  • status - Filter by status (active, paused, completed, archived)
GET
/api/v1/campaigns/:id

Get a specific campaign by ID

Returns campaign details including newsletter count

POST
/api/v1/campaigns

Create a new campaign

Example Request

{
  "name": "Product Launch Campaign",
  "description": "Campaign for new product announcement",
  "subscriberGroupIds": ["group-uuid-1", "group-uuid-2"]
}
PATCH
/api/v1/campaigns/:id

Update a campaign

Example Request

{
  "name": "Updated Campaign Name",
  "description": "Updated description",
  "status": "paused",
  "subscriberGroupIds": ["group-uuid-1"]
}
DELETE
/api/v1/campaigns/:id

Delete a campaign

⚠️ Note: Cannot delete campaigns that contain newsletters. Archive them instead.