knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-11-08 08:41:34 +08:00
Code Issues Projects Releases Packages Wiki Activity
listmonk/docs/apis/campaigns/index.html
github-actions[bot] 5162ba9992 deploy: d2cd9b169e
2024-08-20 09:26:54 +00:00

2367 lines
No EOL
74 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../import/">
<link rel="next" href="../media/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.32">
<title>Campaigns - listmonk / Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.3cba04c6.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../static/style.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="red">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#api-campaigns" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="listmonk / Documentation" class="md-header__button md-logo" aria-label="listmonk / Documentation" data-md-component="logo">
<img src="../../images/favicon.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
listmonk / Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Campaigns
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="listmonk / Documentation" class="md-nav__button md-logo" aria-label="listmonk / Documentation" data-md-component="logo">
<img src="../../images/favicon.png" alt="logo">
</a>
listmonk / Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../upgrade/" class="md-nav__link">
<span class="md-ellipsis">
Upgrade
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Using Listmonk
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Using Listmonk
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../concepts/" class="md-nav__link">
<span class="md-ellipsis">
Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../templating/" class="md-nav__link">
<span class="md-ellipsis">
Templating
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../querying-and-segmentation/" class="md-nav__link">
<span class="md-ellipsis">
Querying and segmenting subscribers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../bounces/" class="md-nav__link">
<span class="md-ellipsis">
Bounce processing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../messengers/" class="md-nav__link">
<span class="md-ellipsis">
Messengers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../archives/" class="md-nav__link">
<span class="md-ellipsis">
Archives
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../i18n/" class="md-nav__link">
<span class="md-ellipsis">
Internationalization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../external-integration/" class="md-nav__link">
<span class="md-ellipsis">
Integrating with external systems
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
API
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
API
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../apis/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../sdks/" class="md-nav__link">
<span class="md-ellipsis">
SDKs and libs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../subscribers/" class="md-nav__link">
<span class="md-ellipsis">
Subscribers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../lists/" class="md-nav__link">
<span class="md-ellipsis">
Lists
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../import/" class="md-nav__link">
<span class="md-ellipsis">
Import
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Campaigns
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Campaigns
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#get-apicampaigns" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example-request" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/{campaign_id}
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/{campaign_id}">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_1" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_1" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignscampaign_idpreview" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/{campaign_id}/preview
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/{campaign_id}/preview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_2" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_2" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignsrunningstats" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/running/stats
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/running/stats">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_3" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_3" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apicampaigns" class="md-nav__link">
<span class="md-ellipsis">
POST /api/campaigns
</span>
</a>
<nav class="md-nav" aria-label="POST /api/campaigns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_4" class="md-nav__link">
<span class="md-ellipsis">
Example request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_4" class="md-nav__link">
<span class="md-ellipsis">
Example response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apicampaignscampaign_idtest" class="md-nav__link">
<span class="md-ellipsis">
POST /api/campaigns/{campaign_id}/test
</span>
</a>
<nav class="md-nav" aria-label="POST /api/campaigns/{campaign_id}/test">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_id_1" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_idstatus" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}/status
</span>
</a>
<nav class="md-nav" aria-label="PUT /api/campaigns/{campaign_id}/status">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#note" class="md-nav__link">
<span class="md-ellipsis">
Note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_5" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#delete-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
DELETE /api/campaigns/{campaign_id}
</span>
</a>
<nav class="md-nav" aria-label="DELETE /api/campaigns/{campaign_id}">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_6" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_6" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../media/" class="md-nav__link">
<span class="md-ellipsis">
Media
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../templates/" class="md-nav__link">
<span class="md-ellipsis">
Templates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transactional/" class="md-nav__link">
<span class="md-ellipsis">
Transactional
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../bounces/" class="md-nav__link">
<span class="md-ellipsis">
Bounces
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Maintenance
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Maintenance
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../maintenance/performance/" class="md-nav__link">
<span class="md-ellipsis">
Performance
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Contributions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Contributions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../developer-setup/" class="md-nav__link">
<span class="md-ellipsis">
Developer setup
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#get-apicampaigns" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#example-request" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/{campaign_id}
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/{campaign_id}">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_1" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_1" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignscampaign_idpreview" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/{campaign_id}/preview
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/{campaign_id}/preview">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_2" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_2" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apicampaignsrunningstats" class="md-nav__link">
<span class="md-ellipsis">
GET /api/campaigns/running/stats
</span>
</a>
<nav class="md-nav" aria-label="GET /api/campaigns/running/stats">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_3" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_3" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apicampaigns" class="md-nav__link">
<span class="md-ellipsis">
POST /api/campaigns
</span>
</a>
<nav class="md-nav" aria-label="POST /api/campaigns">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_4" class="md-nav__link">
<span class="md-ellipsis">
Example request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_4" class="md-nav__link">
<span class="md-ellipsis">
Example response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apicampaignscampaign_idtest" class="md-nav__link">
<span class="md-ellipsis">
POST /api/campaigns/{campaign_id}/test
</span>
</a>
<nav class="md-nav" aria-label="POST /api/campaigns/{campaign_id}/test">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_id_1" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#put-apicampaignscampaign_idstatus" class="md-nav__link">
<span class="md-ellipsis">
PUT /api/campaigns/{campaign_id}/status
</span>
</a>
<nav class="md-nav" aria-label="PUT /api/campaigns/{campaign_id}/status">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#note" class="md-nav__link">
<span class="md-ellipsis">
Note
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_5" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#delete-apicampaignscampaign_id" class="md-nav__link">
<span class="md-ellipsis">
DELETE /api/campaigns/{campaign_id}
</span>
</a>
<nav class="md-nav" aria-label="DELETE /api/campaigns/{campaign_id}">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_6" class="md-nav__link">
<span class="md-ellipsis">
Example Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_6" class="md-nav__link">
<span class="md-ellipsis">
Example Response
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="api-campaigns">API / Campaigns<a class="headerlink" href="#api-campaigns" title="Permanent link">&para;</a></h1>
<table>
<thead>
<tr>
<th style="text-align: left;">Method</th>
<th style="text-align: left;">Endpoint</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">GET</td>
<td style="text-align: left;"><a href="#get-apicampaigns">/api/campaigns</a></td>
<td style="text-align: left;">Retrieve all campaigns.</td>
</tr>
<tr>
<td style="text-align: left;">GET</td>
<td style="text-align: left;"><a href="#get-apicampaignscampaign_id">/api/campaigns/{campaign_id}</a></td>
<td style="text-align: left;">Retrieve a specific campaign.</td>
</tr>
<tr>
<td style="text-align: left;">GET</td>
<td style="text-align: left;"><a href="#get-apicampaignscampaign_idpreview">/api/campaigns/{campaign_id}/preview</a></td>
<td style="text-align: left;">Retrieve preview of a campaign.</td>
</tr>
<tr>
<td style="text-align: left;">GET</td>
<td style="text-align: left;"><a href="#get-apicampaignsrunningstats">/api/campaigns/running/stats</a></td>
<td style="text-align: left;">Retrieve stats of specified campaigns.</td>
</tr>
<tr>
<td style="text-align: left;">POST</td>
<td style="text-align: left;"><a href="#post-apicampaigns">/api/campaigns</a></td>
<td style="text-align: left;">Create a new campaign.</td>
</tr>
<tr>
<td style="text-align: left;">POST</td>
<td style="text-align: left;"><a href="#post-apicampaignscampaign_idtest">/api/campaigns/{campaign_id}/test</a></td>
<td style="text-align: left;">Test campaign with arbitrary subscribers.</td>
</tr>
<tr>
<td style="text-align: left;">PUT</td>
<td style="text-align: left;"><a href="#put-apicampaignscampaign_id">/api/campaigns/{campaign_id}</a></td>
<td style="text-align: left;">Update a campaign.</td>
</tr>
<tr>
<td style="text-align: left;">PUT</td>
<td style="text-align: left;"><a href="#put-apicampaignscampaign_idstatus">/api/campaigns/{campaign_id}/status</a></td>
<td style="text-align: left;">Change status of a campaign.</td>
</tr>
<tr>
<td style="text-align: left;">DELETE</td>
<td style="text-align: left;"><a href="#delete-apicampaignscampaign_id">/api/campaigns/{campaign_id}</a></td>
<td style="text-align: left;">Delete a campaign.</td>
</tr>
</tbody>
</table>
<hr />
<h4 id="get-apicampaigns">GET /api/campaigns<a class="headerlink" href="#get-apicampaigns" title="Permanent link">&para;</a></h4>
<p>Retrieve all campaigns.</p>
<h5 id="example-request">Example Request<a class="headerlink" href="#example-request" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="w"> </span>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns?page=1&amp;per_page=100&#39;</span>
</code></pre></div>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">order</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Sorting order: ASC for ascending, DESC for descending.</td>
</tr>
<tr>
<td style="text-align: left;">order_by</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Result sorting field. Options: name, status, created_at, updated_at.</td>
</tr>
<tr>
<td style="text-align: left;">query</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">SQL query expression to filter campaigns.</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">[]string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Status to filter campaigns. Repeat in the query for multiple values.</td>
</tr>
<tr>
<td style="text-align: left;">tags</td>
<td style="text-align: left;">[]string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Tags to filter campaigns. Repeat in the query for multiple values.</td>
</tr>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Page number for paginated results.</td>
</tr>
<tr>
<td style="text-align: left;">per_page</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Results per page. Set as 'all' for all results.</td>
</tr>
</tbody>
</table>
<h5 id="example-response">Example Response<a class="headerlink" href="#example-response" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;results&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-14T17:36:41.29451+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-14T17:36:41.29451+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;views&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;clicks&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;lists&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default list&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;started_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;to_send&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;sent&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;uuid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;57702beb-6fae-4355-a324-c2fd5b59a549&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;regular&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Test campaign&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Welcome to listmonk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;from_email&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;No Reply &lt;noreply@yoursite.com&gt;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;body&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;h3&gt;Hi {{ .Subscriber.FirstName }}!&lt;/h3&gt;\n\t\t\tThis is a test e-mail campaign. Your second name is {{ .Subscriber.LastName }} and you are from {{ .Subscriber.Attribs.city }}.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;send_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-15T17:36:41.293233+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;draft&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;content_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;richtext&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;test-campaign&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;template_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;messenger&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;email&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;query&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;total&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;per_page&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;page&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h4 id="get-apicampaignscampaign_id">GET /api/campaigns/{campaign_id}<a class="headerlink" href="#get-apicampaignscampaign_id" title="Permanent link">&para;</a></h4>
<p>Retrieve a specific campaign.</p>
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">campaign_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign ID.</td>
</tr>
</tbody>
</table>
<h5 id="example-request_1">Example Request<a class="headerlink" href="#example-request_1" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns/1&#39;</span>
</code></pre></div>
<h5 id="example-response_1">Example Response<a class="headerlink" href="#example-response_1" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-14T17:36:41.29451+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-14T17:36:41.29451+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;views&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;clicks&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;lists&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default list&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;started_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;to_send&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;sent&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;uuid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;57702beb-6fae-4355-a324-c2fd5b59a549&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;regular&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Test campaign&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Welcome to listmonk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;from_email&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;No Reply &lt;noreply@yoursite.com&gt;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;body&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;h3&gt;Hi {{ .Subscriber.FirstName }}!&lt;/h3&gt;\n\t\t\tThis is a test e-mail campaign. Your second name is {{ .Subscriber.LastName }} and you are from {{ .Subscriber.Attribs.city }}.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;send_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-15T17:36:41.293233+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;draft&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;content_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;richtext&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;test-campaign&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;template_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;messenger&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;email&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h4 id="get-apicampaignscampaign_idpreview">GET /api/campaigns/{campaign_id}/preview<a class="headerlink" href="#get-apicampaignscampaign_idpreview" title="Permanent link">&para;</a></h4>
<p>Preview a specific campaign.</p>
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">campaign_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign ID to preview.</td>
</tr>
</tbody>
</table>
<h5 id="example-request_2">Example Request<a class="headerlink" href="#example-request_2" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns/1/preview&#39;</span>
</code></pre></div>
<h5 id="example-response_2">Example Response<a class="headerlink" href="#example-response_2" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">h3</span><span class="p">&gt;</span>Hi John!<span class="p">&lt;/</span><span class="nt">h3</span><span class="p">&gt;</span>
This is a test e-mail campaign. Your second name is Doe and you are from Bengaluru.
</code></pre></div>
<hr />
<h4 id="get-apicampaignsrunningstats">GET /api/campaigns/running/stats<a class="headerlink" href="#get-apicampaignsrunningstats" title="Permanent link">&para;</a></h4>
<p>Retrieve stats of specified campaigns.</p>
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">campaign_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign IDs to get stats for.</td>
</tr>
</tbody>
</table>
<h5 id="example-request_3">Example Request<a class="headerlink" href="#example-request_3" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns/running/stats?campaign_id=1&#39;</span>
</code></pre></div>
<h5 id="example-response_3">Example Response<a class="headerlink" href="#example-response_3" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h4 id="post-apicampaigns">POST /api/campaigns<a class="headerlink" href="#post-apicampaigns" title="Permanent link">&para;</a></h4>
<p>Create a new campaign.</p>
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign name.</td>
</tr>
<tr>
<td style="text-align: left;">subject</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign email subject.</td>
</tr>
<tr>
<td style="text-align: left;">lists</td>
<td style="text-align: left;">number[]</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">List IDs to send campaign to.</td>
</tr>
<tr>
<td style="text-align: left;">from_email</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">'From' email in campaign emails. Defaults to value from settings if not provided.</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign type: 'regular' or 'optin'.</td>
</tr>
<tr>
<td style="text-align: left;">content_type</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Content type: 'richtext', 'html', 'markdown', 'plain'.</td>
</tr>
<tr>
<td style="text-align: left;">body</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Content body of campaign.</td>
</tr>
<tr>
<td style="text-align: left;">altbody</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Alternate plain text body for HTML (and richtext) emails.</td>
</tr>
<tr>
<td style="text-align: left;">send_at</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Timestamp to schedule campaign. Format: 'YYYY-MM-DDTHH:MM:SSZ'.</td>
</tr>
<tr>
<td style="text-align: left;">messenger</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">'email' or a custom messenger defined in settings. Defaults to 'email' if not provided.</td>
</tr>
<tr>
<td style="text-align: left;">template_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Template ID to use. Defaults to default template if not provided.</td>
</tr>
<tr>
<td style="text-align: left;">tags</td>
<td style="text-align: left;">string[]</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Tags to mark campaign.</td>
</tr>
<tr>
<td style="text-align: left;">headers</td>
<td style="text-align: left;">JSON</td>
<td style="text-align: left;"></td>
<td style="text-align: left;">Key-value pairs to send as SMTP headers. Example: [{"x-custom-header": "value"}].</td>
</tr>
</tbody>
</table>
<h5 id="example-request_4">Example request<a class="headerlink" href="#example-request_4" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns&#39;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json;charset=utf-8&#39;</span><span class="w"> </span>--data-raw<span class="w"> </span><span class="s1">&#39;{&quot;name&quot;:&quot;Test campaign&quot;,&quot;subject&quot;:&quot;Hello, world&quot;,&quot;lists&quot;:[1],&quot;from_email&quot;:&quot;listmonk &lt;noreply@listmonk.yoursite.com&gt;&quot;,&quot;content_type&quot;:&quot;richtext&quot;,&quot;messenger&quot;:&quot;email&quot;,&quot;type&quot;:&quot;regular&quot;,&quot;tags&quot;:[&quot;test&quot;],&quot;template_id&quot;:1}&#39;</span>
</code></pre></div>
<h5 id="example-response_4">Example response<a class="headerlink" href="#example-response_4" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2021-12-27T11:50:23.333485Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2021-12-27T11:50:23.333485Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;views&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;clicks&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;bounces&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;lists&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default list&quot;</span>
<span class="w"> </span><span class="p">}],</span>
<span class="w"> </span><span class="nt">&quot;started_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;to_send&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;sent&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;uuid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;90c889cc-3728-4064-bbcb-5c1c446633b3&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;regular&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Test campaign&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Hello, world&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;from_email&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;listmonk \u003cnoreply@listmonk.yoursite.com\u003e&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;body&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;altbody&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;send_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;draft&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;content_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;richtext&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;test&quot;</span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;template_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;messenger&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;email&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h4 id="post-apicampaignscampaign_idtest">POST /api/campaigns/{campaign_id}/test<a class="headerlink" href="#post-apicampaignscampaign_idtest" title="Permanent link">&para;</a></h4>
<p>Test campaign with arbitrary subscribers.</p>
<p>Use the same parameters in <a href="#post-apicampaigns">POST /api/campaigns</a> in addition to the below parameters.</p>
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">subscribers</td>
<td style="text-align: left;">string[]</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">List of subscriber e-mails to send the message to.</td>
</tr>
</tbody>
</table>
<hr />
<h4 id="put-apicampaignscampaign_id">PUT /api/campaigns/{campaign_id}<a class="headerlink" href="#put-apicampaignscampaign_id" title="Permanent link">&para;</a></h4>
<p>Update a campaign.</p>
<blockquote>
<p>Refer to parameters from <a href="#post-apicampaigns">POST /api/campaigns</a></p>
</blockquote>
<hr />
<h4 id="put-apicampaignscampaign_id_1">PUT /api/campaigns/{campaign_id}<a class="headerlink" href="#put-apicampaignscampaign_id_1" title="Permanent link">&para;</a></h4>
<p>Update a specific campaign.</p>
<blockquote>
<p>Refer to parameters from <a href="#post-apicampaigns">POST /api/campaigns</a></p>
</blockquote>
<hr />
<h4 id="put-apicampaignscampaign_idstatus">PUT /api/campaigns/{campaign_id}/status<a class="headerlink" href="#put-apicampaignscampaign_idstatus" title="Permanent link">&para;</a></h4>
<p>Change status of a campaign.</p>
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">campaign_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign ID to change status.</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">New status for campaign: 'scheduled', 'running', 'paused', 'cancelled'.</td>
</tr>
</tbody>
</table>
<h5 id="note">Note<a class="headerlink" href="#note" title="Permanent link">&para;</a></h5>
<blockquote>
<ul>
<li>Only 'scheduled' campaigns can change status to 'draft'.</li>
<li>Only 'draft' campaigns can change status to 'scheduled'.</li>
<li>Only 'paused' and 'draft' campaigns can start ('running' status).</li>
<li>Only 'running' campaigns can change status to 'cancelled' and 'paused'.</li>
</ul>
</blockquote>
<h5 id="example-request_5">Example Request<a class="headerlink" href="#example-request_5" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns/1/status&#39;</span><span class="w"> </span><span class="se">\</span>
--header<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span><span class="se">\</span>
--data-raw<span class="w"> </span><span class="s1">&#39;{&quot;status&quot;:&quot;scheduled&quot;}&#39;</span>
</code></pre></div>
<h5 id="example-response_5">Example Response<a class="headerlink" href="#example-response_5" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-14T17:36:41.29451+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-04-08T19:35:17.331867+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;views&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;clicks&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;lists&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default list&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;started_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;to_send&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;sent&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;uuid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;57702beb-6fae-4355-a324-c2fd5b59a549&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;regular&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Test campaign&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;subject&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Welcome to listmonk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;from_email&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;No Reply &lt;noreply@yoursite.com&gt;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;body&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;h3&gt;Hi {{ .Subscriber.FirstName }}!&lt;/h3&gt;\n\t\t\tThis is a test e-mail campaign. Your second name is {{ .Subscriber.LastName }} and you are from {{ .Subscriber.Attribs.city }}.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;send_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2020-03-15T17:36:41.293233+01:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;scheduled&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;content_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;richtext&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;test-campaign&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;template_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;messenger&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;email&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<hr />
<h4 id="delete-apicampaignscampaign_id">DELETE /api/campaigns/{campaign_id}<a class="headerlink" href="#delete-apicampaignscampaign_id" title="Permanent link">&para;</a></h4>
<p>Delete a campaign.</p>
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Required</th>
<th style="text-align: left;">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">campaign_id</td>
<td style="text-align: left;">number</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">Campaign ID to delete.</td>
</tr>
</tbody>
</table>
<h5 id="example-request_6">Example Request<a class="headerlink" href="#example-request_6" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:password&quot;</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/campaigns/34&#39;</span>
</code></pre></div>
<h5 id="example-response_6">Example Response<a class="headerlink" href="#example-response_6" title="Permanent link">&para;</a></h5>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;data&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
<span class="p">}</span>
</code></pre></div>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
CC BY-SA 4.0
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes", "navigation.sections", "content.code.copy"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.471ce7a9.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink