knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-11-17 14:49:39 +08:00
Code Issues Projects Releases Packages Wiki Activity

deploy: 32b979eeb6

Browse source
This commit is contained in:
github-actions[bot] 2023-08-13 13:19:00 +00:00
parent b381816c71
commit 4af8223bc5
3 changed files with 184 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

227
docs/apis/subscribers/index.html
View file

@ -587,6 +587,47 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apipublicsubscription" class="md-nav__link">
POST /api/public/subscription
</a>
<nav class="md-nav" aria-label="POST /api/public/subscription">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-json-request" class="md-nav__link">
Example JSON Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-form-request" class="md-nav__link">
Example Form Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -598,7 +639,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
<a href="#parameters_4" class="md-nav__link">
Parameters
</a>
@ -612,7 +653,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
<a href="#example-response_6" class="md-nav__link">
Example Response
</a>
@ -632,7 +673,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
<a href="#parameters_5" class="md-nav__link">
Parameters
</a>
@ -652,7 +693,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
<a href="#parameters_6" class="md-nav__link">
Parameters
</a>
@ -666,7 +707,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_6" class="md-nav__link">
<a href="#example-response_7" class="md-nav__link">
Example Response
</a>
@ -693,7 +734,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_7" class="md-nav__link">
<a href="#example-response_8" class="md-nav__link">
Example Response
</a>
@ -713,7 +754,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
<a href="#parameters_7" class="md-nav__link">
Parameters
</a>
@ -727,7 +768,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_8" class="md-nav__link">
<a href="#example-response_9" class="md-nav__link">
Example Response
</a>
@ -747,7 +788,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
<a href="#parameters_8" class="md-nav__link">
Parameters
</a>
@ -761,7 +802,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_9" class="md-nav__link">
<a href="#example-response_10" class="md-nav__link">
Example Response
</a>
@ -788,7 +829,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_10" class="md-nav__link">
<a href="#example-response_11" class="md-nav__link">
Example Response
</a>
@ -1077,6 +1118,47 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apipublicsubscription" class="md-nav__link">
POST /api/public/subscription
</a>
<nav class="md-nav" aria-label="POST /api/public/subscription">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-json-request" class="md-nav__link">
Example JSON Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-form-request" class="md-nav__link">
Example Form Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1088,7 +1170,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_3" class="md-nav__link">
<a href="#parameters_4" class="md-nav__link">
Parameters
</a>
@ -1102,7 +1184,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_5" class="md-nav__link">
<a href="#example-response_6" class="md-nav__link">
Example Response
</a>
@ -1122,7 +1204,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_4" class="md-nav__link">
<a href="#parameters_5" class="md-nav__link">
Parameters
</a>
@ -1142,7 +1224,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_5" class="md-nav__link">
<a href="#parameters_6" class="md-nav__link">
Parameters
</a>
@ -1156,7 +1238,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_6" class="md-nav__link">
<a href="#example-response_7" class="md-nav__link">
Example Response
</a>
@ -1183,7 +1265,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_7" class="md-nav__link">
<a href="#example-response_8" class="md-nav__link">
Example Response
</a>
@ -1203,7 +1285,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_6" class="md-nav__link">
<a href="#parameters_7" class="md-nav__link">
Parameters
</a>
@ -1217,7 +1299,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_8" class="md-nav__link">
<a href="#example-response_9" class="md-nav__link">
Example Response
</a>
@ -1237,7 +1319,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_7" class="md-nav__link">
<a href="#parameters_8" class="md-nav__link">
Parameters
</a>
@ -1251,7 +1333,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_9" class="md-nav__link">
<a href="#example-response_10" class="md-nav__link">
Example Response
</a>
@ -1278,7 +1360,7 @@
</li>
<li class="md-nav__item">
<a href="#example-response_10" class="md-nav__link">
<a href="#example-response_11" class="md-nav__link">
Example Response
</a>
@ -1345,6 +1427,11 @@
<td>Creates a new subscriber.</td>
</tr>
<tr>
<td><code>POST</code></td>
<td><a href="#post-apisubscriberspublic">/api/subscribers</a></td>
<td>Unauthenticated API that enables public subscription.</td>
</tr>
<tr>
<td><code>PUT</code></td>
<td><a href="#put-apisubscriberslists">/api/subscribers/lists</a></td>
<td>Modify subscribers' list memberships.</td>
@ -1389,7 +1476,7 @@
<h4 id="get-apisubscribers"><strong><code>GET</code></strong> /api/subscribers<a class="headerlink" href="#get-apisubscribers" title="Permanent link">&para;</a></h4>
<p>Gets all subscribers. </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>curl<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers?page=1&amp;per_page=100&#39;</span><span class="w"> </span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers?page=1&amp;per_page=100&#39;</span><span class="w"> </span>
</code></pre></div>
<p>To skip pagination and retrieve all records, pass <code>per_page=all</code>.</p>
<h5 id="example-response">Example Response<a class="headerlink" href="#example-response" title="Permanent link">&para;</a></h5>
@ -1491,7 +1578,7 @@
</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><span class="s1">&#39;http://localhost:9000/api/subscribers/1&#39;</span><span class="w"> </span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/1&#39;</span><span class="w"> </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>
@ -1549,7 +1636,7 @@
</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><span class="s1">&#39;http://localhost:9000/api/subscribers?list_id=1&amp;list_id=2&amp;page=1&amp;per_page=100&#39;</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers?list_id=1&amp;list_id=2&amp;page=1&amp;per_page=100&#39;</span>
</code></pre></div>
<p>To skip pagination and retrieve all records, pass <code>per_page=all</code>.</p>
<h5 id="example-response_2">Example Response<a class="headerlink" href="#example-response_2" title="Permanent link">&para;</a></h5>
@ -1595,7 +1682,7 @@
<h4 id="get-apisubscribers_2"><strong><code>GET</code></strong> /api/subscribers<a class="headerlink" href="#get-apisubscribers_2" title="Permanent link">&para;</a></h4>
<p>Gets subscribers with an SQL expression.</p>
<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>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers&#39;</span><span class="w"> </span><span class="se">\</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--url-query<span class="w"> </span><span class="s1">&#39;page=1&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--url-query<span class="w"> </span><span class="s1">&#39;per_page=100&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--url-query<span class="w"> </span><span class="s2">&quot;query=subscribers.name LIKE &#39;Test%&#39; AND subscribers.attribs-&gt;&gt;&#39;city&#39; = &#39;Bengaluru&#39;&quot;</span>
@ -1704,7 +1791,7 @@
</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><span class="s1">&#39;http://localhost:9000/api/subscribers&#39;</span><span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span><span class="se">\</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers&#39;</span><span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--data<span class="w"> </span><span class="s1">&#39;{&quot;email&quot;:&quot;subsriber@domain.com&quot;,&quot;name&quot;:&quot;The Subscriber&quot;,&quot;status&quot;:&quot;enabled&quot;,&quot;lists&quot;:[1],&quot;attribs&quot;:{&quot;city&quot;:&quot;Bengaluru&quot;,&quot;projects&quot;:3,&quot;stack&quot;:{&quot;languages&quot;:[&quot;go&quot;,&quot;python&quot;]}}}&#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>
@ -1726,9 +1813,61 @@
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<h4 id="post-apipublicsubscription"><strong><code>POST</code></strong> /api/public/subscription<a class="headerlink" href="#post-apipublicsubscription" title="Permanent link">&para;</a></h4>
<p>This is a public, unauthenticated API meant for directly integrating forms for public subscription. The API supports both
form encoded or a JSON encoded body. </p>
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Parameter type</th>
<th>Data type</th>
<th>Required/Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>email</td>
<td>Request body</td>
<td>String</td>
<td>Required</td>
<td>The email address of the subscriber.</td>
</tr>
<tr>
<td>name</td>
<td>Request body</td>
<td>String</td>
<td>Optional</td>
<td>The name of the new subscriber.</td>
</tr>
<tr>
<td>list_uuids</td>
<td>Request body</td>
<td>Strings</td>
<td>Required</td>
<td>Array of list UUIDs.</td>
</tr>
</tbody>
</table>
<h5 id="example-json-request">Example JSON Request<a class="headerlink" href="#example-json-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="s1">&#39;http://localhost:9000/api/public/subscription&#39;</span><span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--data<span class="w"> </span><span class="s1">&#39;{&quot;email&quot;:&quot;subsriber@domain.com&quot;,&quot;name&quot;:&quot;The Subscriber&quot;, &quot;lists&quot;: [&quot;eb420c55-4cfb-4972-92ba-c93c34ba475d&quot;, &quot;0c554cfb-eb42-4972-92ba-c93c34ba475d&quot;]}&#39;</span>
</code></pre></div>
<h5 id="example-form-request">Example Form Request<a class="headerlink" href="#example-form-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="s1">&#39;http://localhost:9000/api/public/subscription&#39;</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;email=subsriber@domain.com&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;name=The Subscriber&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;l=eb420c55-4cfb-4972-92ba-c93c34ba475d&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;l=0c554cfb-eb42-4972-92ba-c93c34ba475d&#39;</span>
</code></pre></div>
<p>Notice that in form request, there param is <code>l</code> that is repeated for multiple lists, and not <code>lists</code> like in JSON.</p>
<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="kc">true</span>
<span class="p">}</span>
</code></pre></div>
<h4 id="put-apisubscriberslists"><strong><code>PUT</code></strong> /api/subscribers/lists<a class="headerlink" href="#put-apisubscriberslists" title="Permanent link">&para;</a></h4>
<p>Modify subscribers list memberships.</p>
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">&para;</a></h5>
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
@ -1772,24 +1911,24 @@
</table>
<h5 id="example-request_5">Example Request<a class="headerlink" href="#example-request_5" title="Permanent link">&para;</a></h5>
<p>To subscribe users 1, 2, and 3 to lists 4, 5, and 6:</p>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">&quot;username:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/lists&#39;</span><span class="w"> </span><span class="se">\</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/lists&#39;</span><span class="w"> </span><span class="se">\</span>
--data-raw<span class="w"> </span><span class="s1">&#39;{&quot;ids&quot;: [1, 2, 3], &quot;action&quot;: &quot;add&quot;, &quot;target_list_ids&quot;: [4, 5, 6], &quot;status&quot;: &quot;confirmed&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>
<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><span class="w"> </span>
</code></pre></div>
<h4 id="put-apisubscribersid"><strong><code>PUT</code></strong> /api/subscribers/:<code>id</code><a class="headerlink" href="#put-apisubscribersid" title="Permanent link">&para;</a></h4>
<p>Updates a single subscriber.</p>
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">&para;</a></h5>
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">&para;</a></h5>
<p>Parameters are the same as <a href="#post-apisubscribers">POST /api/subscribers</a> used for subscriber creation. </p>
<blockquote>
<p>Please note that this is a <code>PUT</code> request, so all the parameters have to be set. For example if you don't provide <code>lists</code>, the subscriber will be deleted from all the lists he was previously signed on.</p>
</blockquote>
<h4 id="put-apisubscribersidblocklist"><strong><code>PUT</code></strong> /api/subscribers/:<code>id</code>/blocklist<a class="headerlink" href="#put-apisubscribersidblocklist" title="Permanent link">&para;</a></h4>
<p>Blocklists a single subscriber.</p>
<h5 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">&para;</a></h5>
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
@ -1811,9 +1950,9 @@
</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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/9/blocklist&#39;</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/9/blocklist&#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>
<h5 id="example-response_7">Example Response<a class="headerlink" href="#example-response_7" 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><span class="w"> </span>
@ -1821,20 +1960,20 @@
<h4 id="put-apisubscribersqueryblocklist"><strong><code>PUT</code></strong> /api/subscribers/query/blocklist<a class="headerlink" href="#put-apisubscribersqueryblocklist" title="Permanent link">&para;</a></h4>
<p>Blocklists subscribers with an arbitrary sql expression.</p>
<h5 id="example-request_7">Example Request<a class="headerlink" href="#example-request_7" 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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/query/blocklist&#39;</span><span class="w"> </span><span class="se">\</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/query/blocklist&#39;</span><span class="w"> </span><span class="se">\</span>
--data-raw<span class="w"> </span><span class="s1">&#39;&quot;query=subscribers.name LIKE &#39;</span><span class="se">\&#39;</span><span class="s1">&#39;John Doe&#39;</span><span class="se">\&#39;</span><span class="s1">&#39; AND subscribers.attribs-&gt;&gt;&#39;</span><span class="se">\&#39;</span><span class="s1">&#39;city&#39;</span><span class="se">\&#39;</span><span class="s1">&#39; = &#39;</span><span class="se">\&#39;</span><span class="s1">&#39;Bengaluru&#39;</span><span class="se">\&#39;</span><span class="s1">&#39;&quot;&#39;</span>
</code></pre></div>
<blockquote>
<p>Refer to the <a href="/querying-and-segmentation#querying-and-segmenting-subscribers">querying and segmentation</a> section for more information on how to query subscribers with SQL expressions.</p>
</blockquote>
<h5 id="example-response_7">Example Response<a class="headerlink" href="#example-response_7" title="Permanent link">&para;</a></h5>
<h5 id="example-response_8">Example Response<a class="headerlink" href="#example-response_8" 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>
<h4 id="delete-apisubscribersid"><strong><code>DELETE</code></strong> /api/subscribers/:<code>id</code><a class="headerlink" href="#delete-apisubscribersid" title="Permanent link">&para;</a></h4>
<p>Deletes a single subscriber. </p>
<h5 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">&para;</a></h5>
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
@ -1856,16 +1995,16 @@
</tbody>
</table>
<h5 id="example-request_8">Example Request<a class="headerlink" href="#example-request_8" 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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/9&#39;</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/9&#39;</span>
</code></pre></div>
<h5 id="example-response_8">Example Response<a class="headerlink" href="#example-response_8" title="Permanent link">&para;</a></h5>
<h5 id="example-response_9">Example Response<a class="headerlink" href="#example-response_9" 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>
<h4 id="delete-apisubscribers"><strong><code>DELETE</code></strong> /api/subscribers<a class="headerlink" href="#delete-apisubscribers" title="Permanent link">&para;</a></h4>
<p>Deletes one or more subscribers.</p>
<h5 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">&para;</a></h5>
<h5 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
@ -1887,9 +2026,9 @@
</tbody>
</table>
<h5 id="example-request_9">Example Request<a class="headerlink" href="#example-request_9" 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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers?id=10&amp;id=11&#39;</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers?id=10&amp;id=11&#39;</span>
</code></pre></div>
<h5 id="example-response_9">Example Response<a class="headerlink" href="#example-response_9" title="Permanent link">&para;</a></h5>
<h5 id="example-response_10">Example Response<a class="headerlink" href="#example-response_10" 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>
@ -1897,13 +2036,13 @@
<h4 id="post-apisubscribersquerydelete"><strong><code>POST</code></strong> /api/subscribers/query/delete<a class="headerlink" href="#post-apisubscribersquerydelete" title="Permanent link">&para;</a></h4>
<p>Deletes subscribers with an arbitrary SQL expression.</p>
<h5 id="example-request_10">Example Request<a class="headerlink" href="#example-request_10" 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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/query/delete&#39;</span><span class="w"> </span><span class="se">\</span>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">&#39;username:password&#39;</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/subscribers/query/delete&#39;</span><span class="w"> </span><span class="se">\</span>
--data-raw<span class="w"> </span><span class="s1">&#39;&quot;query=subscribers.name LIKE &#39;</span><span class="se">\&#39;</span><span class="s1">&#39;John Doe&#39;</span><span class="se">\&#39;</span><span class="s1">&#39; AND subscribers.attribs-&gt;&gt;&#39;</span><span class="se">\&#39;</span><span class="s1">&#39;city&#39;</span><span class="se">\&#39;</span><span class="s1">&#39; = &#39;</span><span class="se">\&#39;</span><span class="s1">&#39;Bengaluru&#39;</span><span class="se">\&#39;</span><span class="s1">&#39;&quot;&#39;</span>
</code></pre></div>
<blockquote>
<p>Refer to the <a href="/querying-and-segmentation#querying-and-segmenting-subscribers">querying and segmentation</a> section for more information on how to query subscribers with SQL expressions.</p>
</blockquote>
<h5 id="example-response_10">Example Response<a class="headerlink" href="#example-response_10" title="Permanent link">&para;</a></h5>
<h5 id="example-response_11">Example Response<a class="headerlink" href="#example-response_11" 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>

2
docs/search/search_index.json
View file

File diff suppressed because one or more lines are too long

BIN
docs/sitemap.xml.gz
View file

Binary file not shown.