Campaigns API

Create and send bulk marketing campaigns to your contact segments. Requires an API key with the write scope.

Base: https://mail.misar.io/api/v1/campaigns

Endpoints

Method	Path	Description
GET	`/v1/campaigns`	List campaigns
POST	`/v1/campaigns`	Create a campaign
GET	`/v1/campaigns/:id`	Get a single campaign
PATCH	`/v1/campaigns/:id`	Update a draft campaign
DELETE	`/v1/campaigns/:id`	Delete a draft campaign
POST	`/v1/campaigns/:id/send`	Send or schedule a campaign

GET /v1/campaigns

List campaigns with optional status filtering.

Query Parameters

Param	Default	Description
`status`	—	Filter: `draft`, `scheduled`, `sending`, `sent`, `failed`
`page`	1	Page number
`per_page`	20	Per page (max 50)

Response

{
  "success": true,
  "campaigns": [
    {
      "id":                "550e8400-e29b-41d4-a716-446655440000",
      "name":              "March Newsletter",
      "subject":           "What's new this month",
      "status":            "sent",
      "total_recipients":  5000,
      "total_sent":        5000,
      "total_opened":      1250,
      "total_clicked":     340,
      "total_bounced":     12,
      "sent_at":           "2026-03-01T10:00:00Z",
      "created_at":        "2026-02-25T09:00:00Z"
    }
  ],
  "pagination": { "page": 1, "per_page": 20, "total": 8 }
}

POST /v1/campaigns

Create a new campaign draft. Plan campaign limits apply.

Request Body

{
  "name":        "March Newsletter",
  "subject":     "What's new this month",
  "from_name":   "Misar Team",
  "from_email":  "newsletter@yourdomain.com",
  "reply_to":    "support@yourdomain.com",
  "segment_id":  "550e8400-e29b-41d4-a716-446655440001",
  "template_id": "550e8400-e29b-41d4-a716-446655440002",
  "body_html":   "<h1>Hello {{first_name}}!</h1>",
  "body_text":   "Hello {{first_name}}!"
}

Field	Required	Notes
`name`	✓	Internal campaign name
`subject`	✓	Email subject (supports `{{variables}}`)
`from_email`	✓	Must be a verified account
`segment_id`	✓	Target audience segment
`template_id` or `body_html`	✓ (one)	Use saved template or inline HTML
`body_text`	—	Plain text fallback (recommended)

Response

{
  "success":  true,
  "campaign": { "id": "...", "name": "March Newsletter", "status": "draft" }
}

Errors

403 — Campaign limit reached for your plan

POST /v1/campaigns/:id/send

Send or schedule a draft campaign. The campaign must be in draft status.

Request Body

{
  "send_at": "2026-04-01T10:00:00Z"
}

Omit send_at to send immediately.

Response

{
  "success":               true,
  "campaign_id":           "...",
  "status":                "sending",
  "estimated_recipients":  5000
}

Errors

400 — Campaign is not in draft status
400 — from_email is not a verified account
429 — Daily or monthly send limit would be exceeded