Campaigns

curl -u 'username:password' -X POST 'http://localhost:9000/api/campaigns/content' \
  -H 'Content-Type: application/json' \
  -d '{
    "from": "markdown",
    "to": "html",
    "body": "# Hello\n\nThis is **markdown** content"
  }'

{
  "name": "Weekly Newsletter",
  "subject": "This Week's Updates",
  "send_at": "2024-03-15T09:00:00Z",
  "lists": [1, 2]
}

<!-- Basic subscriber data -->
<p>Hello {{ .Subscriber.Name }}!</p>
<p>Email: {{ .Subscriber.Email }}</p>
<p>UUID: {{ .Subscriber.UUID }}</p>

<!-- Custom attributes -->
<p>City: {{ .Subscriber.Attribs.city }}</p>
<p>Plan: {{ .Subscriber.Attribs.plan }}</p>

<p>Campaign: {{ .Campaign.Name }}</p>
<p>From: {{ .Campaign.FromEmail }}</p>
<p>Sent: {{ .Campaign.SendAt }}</p>

<!-- Track campaign views -->
{{ TrackView }}

<!-- Track link clicks -->
<a href="{{ TrackLink "https://example.com" }}">Click here</a>

<!-- Unsubscribe URL -->
<a href="{{ UnsubscribeURL }}">Unsubscribe</a>

<!-- Manage preferences URL -->
<a href="{{ ManageURL }}">Manage preferences</a>

<!-- Opt-in URL (for opt-in campaigns) -->
<a href="{{ OptinURL }}">Confirm subscription</a>

<!-- Date formatting -->
{{ .Campaign.SendAt | date "2006-01-02" }}

<!-- String manipulation -->
{{ .Subscriber.Name | upper }}
{{ .Subscriber.Email | lower }}

<!-- Conditionals -->
{{ if eq .Subscriber.Attribs.plan "premium" }}
  <p>Premium content here</p>
{{ end }}

<!-- Loops -->
{{ range .Lists }}
  <li>{{ .Name }}</li>
{{ end }}

{
  "email": "[email protected]",
  "name": "Demo Subscriber",
  "uuid": "00000000-0000-0000-0000-000000000000",
  "attribs": {"city": "Bengaluru"}
}

# Get view analytics
curl -u 'username:password' \
  'http://localhost:9000/api/campaigns/analytics/views?id=1&from=2024-01-01&to=2024-01-31'

# Get link analytics
curl -u 'username:password' \
  'http://localhost:9000/api/campaigns/analytics/links?id=1&from=2024-01-01&to=2024-01-31'

{
  "archive": true,
  "archive_slug": "january-newsletter",
  "archive_template_id": 1,
  "archive_meta": {
    "featured": true,
    "category": "newsletter"
  }
}

{
  "headers": [
    {"X-Campaign-ID": "CAMP-2024-01"},
    {"X-Mailer": "listmonk"}
  ]
}

{
  "media": [1, 2, 3]
}

# By IDs
curl -u 'username:password' -X DELETE 'http://localhost:9000/api/campaigns?id=1&id=2&id=3'

# By query
curl -u 'username:password' -X DELETE 'http://localhost:9000/api/campaigns?query=name%20LIKE%20%27test%25%27'

CREATE TABLE campaigns (
    id               SERIAL PRIMARY KEY,
    uuid             UUID NOT NULL UNIQUE,
    name             TEXT NOT NULL,
    subject          TEXT NOT NULL,
    from_email       TEXT NOT NULL,
    body             TEXT NOT NULL,
    body_source      TEXT NULL,
    altbody          TEXT NULL,
    content_type     content_type NOT NULL DEFAULT 'richtext',
    send_at          TIMESTAMP WITH TIME ZONE,
    headers          JSONB NOT NULL DEFAULT '[]',
    attribs          JSONB NOT NULL DEFAULT '{}',
    status           campaign_status NOT NULL DEFAULT 'draft',
    tags             VARCHAR(100)[],
    type             campaign_type DEFAULT 'regular',
    messenger        TEXT NOT NULL,
    template_id      INTEGER REFERENCES templates(id),
    to_send          INT NOT NULL DEFAULT 0,
    sent             INT NOT NULL DEFAULT 0,
    archive          BOOLEAN NOT NULL DEFAULT false,
    archive_slug     TEXT NULL UNIQUE,
    started_at       TIMESTAMP WITH TIME ZONE,
    created_at       TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
    updated_at       TIMESTAMP WITH TIME ZONE DEFAULT NOW()
);

CREATE TYPE campaign_status AS ENUM 
  ('draft', 'running', 'scheduled', 'paused', 'cancelled', 'finished');
  
CREATE TYPE campaign_type AS ENUM ('regular', 'optin');

CREATE TYPE content_type AS ENUM 
  ('richtext', 'html', 'plain', 'markdown', 'visual');