Documentation

Get your account ready to send in minutes. Manage subscribers from your own system with the REST API and receive events instantly through webhooks.

  1. 1
    Add and verify your domain

    Panel → Domains → Add. Enter the SPF, DKIM (mx1._domainkey), DMARC and bounce-subdomain records shown into your DNS provider and click 'Verify DNS'.

  2. 2
    Create a list and import subscribers

    Panel → Lists. The CSV needs an 'email' column; first name, last name and other columns become custom fields. Typos and invalid addresses are filtered at import.

  3. 3
    Send a campaign

    Panel → Campaigns → New. Pick a template, personalise, send yourself a test, then schedule.

Example request

Create a subscriber. Existing addresses are updated; suppressed addresses are not added and the response carries suppressed: true.

curl -X POST https://t.winnermailing.com/v1/subscribers \
  -H "Authorization: Bearer wm_live_XXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ayse@example.com",
    "first_name": "Ayşe",
    "attributes": { "city": "İstanbul" },
    "lists": ["<list-id>"],
    "double_opt_in": true
  }'

Endpoints

MethodPathDescription
GET/v1/meCustomer and plan information for the key
GET/v1/listsReturns lists
POST/v1/listsCreates a list
POST/v1/subscribersCreates or updates a subscriber
POST/v1/subscribers/importBulk import (1,000 per request)
GET/v1/subscribersLists subscribers (email, status, limit, offset)
GET/v1/subscribers/:idSingle subscriber
DELETE/v1/subscribers/:idUnsubscribes and suppresses the subscriber
GET/v1/campaignsCampaigns with summary counters
GET/v1/campaigns/:idCampaign report

Webhook

Choose a URL and event types under Panel → Webhooks. Every call is signed with HMAC-SHA256 using the webhook secret; failed deliveries are retried with increasing delays. Event types:

subscribesentopenclickbouncecomplaintunsubscribe

Authentication

Every API request needs an 'Authorization: Bearer <api key>' header. Keys are created under Panel → API keys and shown only once, at creation.

Rate limits

600 requests per minute per key. The bulk import endpoint accepts up to 1,000 subscribers per request.

Reach your confirmed subscribers today

Start on the free plan: 2,000 emails/month, 500 subscribers, no credit card required.

Sign in