knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-10-07 13:57:38 +08:00
Code Issues Projects Releases Packages Wiki Activity
listmonk/docs/apis/transactional/index.html
github-actions[bot] af1b2f6b4c deploy: e332622db9
2023-04-25 16:48:21 +00:00

771 lines
No EOL
18 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="../templates/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
<title>API / Transactional - listmonk / Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.ded33207.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.a0c5b2b5.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-transactional" 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">
API / Transactional
</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" 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">
Introduction
</a>
</li>
<li class="md-nav__item">
<a href="../../installation/" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="../../upgrade/" class="md-nav__link">
Upgrade
</a>
</li>
<li class="md-nav__item">
<a href="../../configuration/" class="md-nav__link">
Configuration
</a>
</li>
<li class="md-nav__item">
<a href="../../developer-setup/" class="md-nav__link">
Developer setup
</a>
</li>
<li class="md-nav__item">
<a href="../../concepts/" class="md-nav__link">
Concepts
</a>
</li>
<li class="md-nav__item">
<a href="../../querying-and-segmentation/" class="md-nav__link">
Querying and segmenting subscribers
</a>
</li>
<li class="md-nav__item">
<a href="../../templating/" class="md-nav__link">
Templating
</a>
</li>
<li class="md-nav__item">
<a href="../../bounces/" class="md-nav__link">
Bounce processing
</a>
</li>
<li class="md-nav__item">
<a href="../../messengers/" class="md-nav__link">
Messengers
</a>
</li>
<li class="md-nav__item">
<a href="../../i18n/" class="md-nav__link">
Internationalization
</a>
</li>
<li class="md-nav__item">
<a href="../../external-integration/" class="md-nav__link">
Integrating with external systems
</a>
</li>
<li class="md-nav__item">
<a href="../apis/" class="md-nav__link">
API
</a>
</li>
<li class="md-nav__item">
<a href="../subscribers/" class="md-nav__link">
API / Subscribers
</a>
</li>
<li class="md-nav__item">
<a href="../lists/" class="md-nav__link">
API / Lists
</a>
</li>
<li class="md-nav__item">
<a href="../import/" class="md-nav__link">
API / Import
</a>
</li>
<li class="md-nav__item">
<a href="../campaigns/" class="md-nav__link">
API / Campaigns
</a>
</li>
<li class="md-nav__item">
<a href="../media/" class="md-nav__link">
API / Media
</a>
</li>
<li class="md-nav__item">
<a href="../templates/" class="md-nav__link">
API / Templates
</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">
API / Transactional
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
API / Transactional
</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="#post-apitx" class="md-nav__link">
POST /api/tx
</a>
<nav class="md-nav" aria-label="POST /api/tx">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#request" class="md-nav__link">
Request
</a>
</li>
<li class="md-nav__item">
<a href="#response" class="md-nav__link">
Response
</a>
</li>
</ul>
</nav>
</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="#post-apitx" class="md-nav__link">
POST /api/tx
</a>
<nav class="md-nav" aria-label="POST /api/tx">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#request" class="md-nav__link">
Request
</a>
</li>
<li class="md-nav__item">
<a href="#response" class="md-nav__link">
Response
</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-transactional">API / Transactional<a class="headerlink" href="#api-transactional" title="Permanent link">&para;</a></h1>
<table>
<thead>
<tr>
<th align="left">Method</th>
<th align="left">Endpoint</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>POST</code></td>
<td align="left">/api/tx</td>
<td align="left"></td>
</tr>
</tbody>
</table>
<h2 id="post-apitx">POST /api/tx<a class="headerlink" href="#post-apitx" title="Permanent link">&para;</a></h2>
<p>Send a transactional message to a subscriber using a predefined transactional template.</p>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th align="left">Name</th>
<th align="left">Data Type</th>
<th align="left">Optional</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"><code>subscriber_email</code></td>
<td align="left">String</td>
<td align="left">Optional</td>
<td align="left">E-mail of the subscriber. Either this or <code>subscriber_id</code> should be passed.</td>
</tr>
<tr>
<td align="left"><code>subscriber_id</code></td>
<td align="left">Number</td>
<td align="left">Optional</td>
<td align="left">ID of the subscriber. Either this or <code>subscriber_email</code> should be passed.</td>
</tr>
<tr>
<td align="left"><code>template_id</code></td>
<td align="left">Number</td>
<td align="left">Required</td>
<td align="left">ID of the transactional template to use in the message.</td>
</tr>
<tr>
<td align="left"><code>from_email</code></td>
<td align="left">String</td>
<td align="left">Optional</td>
<td align="left">Optional <code>from</code> email. eg: <code>Company &lt;email@company.com&gt;</code></td>
</tr>
<tr>
<td align="left"><code>data</code></td>
<td align="left">Map</td>
<td align="left">Optional</td>
<td align="left">Optional data in <code>{}</code> nested map. Available in the template as <code>{{ .Tx.Data.* }}</code></td>
</tr>
<tr>
<td align="left"><code>headers</code></td>
<td align="left">[]Map</td>
<td align="left">Optional</td>
<td align="left">Optional array of mail headers. <code>[{"key": "value"}, {"key": "value"}]</code></td>
</tr>
<tr>
<td align="left"><code>messenger</code></td>
<td align="left">String</td>
<td align="left">Optional</td>
<td align="left">Messenger to use to send the message. Default value is <code>email</code>.</td>
</tr>
<tr>
<td align="left"><code>content_type</code></td>
<td align="left">String</td>
<td align="left">Optional</td>
<td align="left"><code>html</code>, <code>markdown</code>, <code>plain</code></td>
</tr>
</tbody>
</table>
<h5 id="request">Request<a class="headerlink" href="#request" 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="s2">&quot;http://localhost:9000/api/tx&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="se">\</span>
<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><span class="se">\</span>
<span class="w"> </span>--data-binary<span class="w"> </span>@-<span class="w"> </span><span class="s">&lt;&lt; EOF</span>
<span class="s"> {</span>
<span class="s"> &quot;subscriber_email&quot;: &quot;user@test.com&quot;,</span>
<span class="s"> &quot;template_id&quot;: 2,</span>
<span class="s"> &quot;data&quot;: {&quot;order_id&quot;: &quot;1234&quot;, &quot;date&quot;: &quot;2022-07-30&quot;, &quot;items&quot;: [1, 2, 3]},</span>
<span class="s"> &quot;content_type&quot;: &quot;html&quot;</span>
<span class="s"> }</span>
<span class="s">EOF</span>
</code></pre></div>
<h5 id="response">Response<a class="headerlink" href="#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="kc">true</span>
<span class="p">}</span>
</code></pre></div>
</article>
</div>
</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">
Copyright &copy; 2019-2023, Kailash Nadh.
</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": [], "search": "../../assets/javascripts/workers/search.208ed371.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.51198bba.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink