knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-10-09 23:06:36 +08:00
Code Issues Projects Releases Packages Wiki Activity
listmonk/docs/apis/lists/index.html
github-actions[bot] bd201c5783 deploy: 52a7298a9d
2023-08-27 07:25:07 +00:00

1289 lines
No EOL
36 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="../subscribers/">
<link rel="next" href="../import/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<title>API / Lists - listmonk / Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.0e669242.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.85d0ee34.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-lists" 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 / Lists
</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">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<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="../../upgrade/" class="md-nav__link">
<span class="md-ellipsis">
Upgrade
</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="../../developer-setup/" class="md-nav__link">
<span class="md-ellipsis">
Developer setup
</span>
</a>
</li>
<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="../../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="../../templating/" class="md-nav__link">
<span class="md-ellipsis">
Templating
</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>
<li class="md-nav__item">
<a href="../apis/" class="md-nav__link">
<span class="md-ellipsis">
API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../subscribers/" class="md-nav__link">
<span class="md-ellipsis">
API / Subscribers
</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">
API / Lists
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
API / Lists
</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-apilists" class="md-nav__link">
GET /api/lists
</a>
<nav class="md-nav" aria-label="GET /api/lists">
<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="#example-request" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apilistslist_id" class="md-nav__link">
GET /api/lists/:list_id
</a>
<nav class="md-nav" aria-label="GET /api/lists/:list_id">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_1" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_1" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apilists" class="md-nav__link">
POST /api/lists
</a>
<nav class="md-nav" aria-label="POST /api/lists">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_2" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_2" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#put-apilistslist_id" class="md-nav__link">
PUT /api/lists/list_id
</a>
<nav class="md-nav" aria-label="PUT /api/lists/list_id">
<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-request_3" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_3" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../import/" class="md-nav__link">
<span class="md-ellipsis">
API / Import
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../campaigns/" class="md-nav__link">
<span class="md-ellipsis">
API / Campaigns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../media/" class="md-nav__link">
<span class="md-ellipsis">
API / Media
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../templates/" class="md-nav__link">
<span class="md-ellipsis">
API / Templates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../transactional/" class="md-nav__link">
<span class="md-ellipsis">
API / Transactional
</span>
</a>
</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-apilists" class="md-nav__link">
GET /api/lists
</a>
<nav class="md-nav" aria-label="GET /api/lists">
<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="#example-request" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#get-apilistslist_id" class="md-nav__link">
GET /api/lists/:list_id
</a>
<nav class="md-nav" aria-label="GET /api/lists/:list_id">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_1" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_1" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_1" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-apilists" class="md-nav__link">
POST /api/lists
</a>
<nav class="md-nav" aria-label="POST /api/lists">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#parameters_2" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="#example-request_2" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_2" class="md-nav__link">
Example Response
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#put-apilistslist_id" class="md-nav__link">
PUT /api/lists/list_id
</a>
<nav class="md-nav" aria-label="PUT /api/lists/list_id">
<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-request_3" class="md-nav__link">
Example Request
</a>
</li>
<li class="md-nav__item">
<a href="#example-response_3" class="md-nav__link">
Example 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-lists">API / Lists<a class="headerlink" href="#api-lists" title="Permanent link">&para;</a></h1>
<table>
<thead>
<tr>
<th>Method</th>
<th>Endpoint</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>GET</code></td>
<td><a href="#get-apilists">/api/lists</a></td>
<td>Gets all lists.</td>
</tr>
<tr>
<td><code>GET</code></td>
<td><a href="#get-apilistslist_id">/api/lists/:<code>list_id</code></a></td>
<td>Gets a single list.</td>
</tr>
<tr>
<td><code>POST</code></td>
<td><a href="#post-apilists">/api/lists</a></td>
<td>Creates a new list.</td>
</tr>
<tr>
<td><code>PUT</code></td>
<td>/api/lists/:<code>list_id</code></td>
<td>Modifies a list.</td>
</tr>
<tr>
<td><code>DELETE</code></td>
<td><a href="#put-apilistslist_id">/api/lists/:<code>list_id</code></a></td>
<td>Deletes a list.</td>
</tr>
</tbody>
</table>
<h4 id="get-apilists"><strong><code>GET</code></strong> /api/lists<a class="headerlink" href="#get-apilists" title="Permanent link">&para;</a></h4>
<p>Gets lists.</p>
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">&para;</a></h5>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required/Optional</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>query</code></td>
<td>string</td>
<td>Optional</td>
<td>Optional string to search a list by name.</td>
</tr>
<tr>
<td><code>order_by</code></td>
<td>string</td>
<td>Optional</td>
<td>Field to sort results by. <code>name|status|created_at|updated_at</code></td>
</tr>
<tr>
<td><code>order</code></td>
<td>string</td>
<td>Optional</td>
<td><code>ASC|DESC</code>Sort by ascending or descending order.</td>
</tr>
<tr>
<td><code>page</code></td>
<td>number</td>
<td>Optional</td>
<td>Page number for paginated results.</td>
</tr>
<tr>
<td><code>per_page</code></td>
<td>number</td>
<td>Optional</td>
<td>Results to return per page. Setting this to <code>all</code> skips pagination and returns all results.</td>
</tr>
</tbody>
</table>
<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>-u<span class="w"> </span><span class="s2">&quot;username:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/lists?page=1&amp;per_page=100&#39;</span>
</code></pre></div>
<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-02-10T23:07:16.194843+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-06T22:32:01.118327+01:00&quot;</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;ce13e971-c2ed-4069-bd0c-240e9a9f56f9&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;Default list&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;public&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;optin&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;double&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&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;subscriber_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">2</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">2</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-04T21:12:09.555013+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-06T22:34:46.405031+01:00&quot;</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;f20a2308-dfb5-4420-a56d-ecf0618a102d&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;get&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;private&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;optin&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;single&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="nt">&quot;subscriber_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</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;total&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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>
<h4 id="get-apilistslist_id"><strong><code>GET</code></strong> /api/lists/:<code>list_id</code><a class="headerlink" href="#get-apilistslist_id" title="Permanent link">&para;</a></h4>
<p>Gets a single list.</p>
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" 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><code>list_id</code></td>
<td>Path parameter</td>
<td>number</td>
<td>Required</td>
<td>The id value of the list you want to get.</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:username&quot;</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">&#39;http://localhost:9000/api/lists/5&#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">5</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-07T06:31:06.072483+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-07T06:31:06.072483+01:00&quot;</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;1bb246ab-7417-4cef-bddc-8fc8fc941d3a&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 list&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;public&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;optin&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;double&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="nt">&quot;subscriber_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
<h4 id="post-apilists"><strong><code>POST</code></strong> /api/lists<a class="headerlink" href="#post-apilists" title="Permanent link">&para;</a></h4>
<p>Creates a new list.</p>
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" 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>name</td>
<td>Request body</td>
<td>string</td>
<td>Required</td>
<td>The new list name.</td>
</tr>
<tr>
<td>type</td>
<td>Request body</td>
<td>string</td>
<td>Required</td>
<td>List type, can be set to <code>private</code> or <code>public</code>.</td>
</tr>
<tr>
<td>optin</td>
<td>Request body</td>
<td>string</td>
<td>Required</td>
<td><code>single</code> or <code>double</code> optin.</td>
</tr>
<tr>
<td>tags</td>
<td>Request body</td>
<td>string[]</td>
<td>Optional</td>
<td>The tags associated with the list.</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: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/lists&#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">{</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">5</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-07T06:31:06.072483+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-07T06:31:06.072483+01:00&quot;</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;1bb246ab-7417-4cef-bddc-8fc8fc941d3a&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 list&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;public&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="nt">&quot;subscriber_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
<span class="kc">null</span>
</code></pre></div>
<h4 id="put-apilistslist_id"><strong><code>PUT</code></strong> /api/lists/<code>list_id</code><a class="headerlink" href="#put-apilistslist_id" title="Permanent link">&para;</a></h4>
<p>Modifies a list.</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><code>list_id</code></td>
<td>Path parameter</td>
<td>number</td>
<td>Required</td>
<td>The id of the list to be modified.</td>
</tr>
<tr>
<td>name</td>
<td>Request body</td>
<td>string</td>
<td>Optional</td>
<td>The name which the old name will be modified to.</td>
</tr>
<tr>
<td>type</td>
<td>Request body</td>
<td>string</td>
<td>Optional</td>
<td>List type, can be set to <code>private</code> or <code>public</code>.</td>
</tr>
<tr>
<td>optin</td>
<td>Request body</td>
<td>string</td>
<td>Optional</td>
<td><code>single</code> or <code>double</code> optin.</td>
</tr>
<tr>
<td>tags</td>
<td>Request body</td>
<td>string[]</td>
<td>Optional</td>
<td>The tags associated with the list.</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: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/lists/5&#39;</span><span class="w"> </span><span class="se">\</span>
--form<span class="w"> </span><span class="s1">&#39;name=modified test list&#39;</span><span class="w"> </span><span class="se">\</span>
--form<span class="w"> </span><span class="s1">&#39;type=private&#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="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">5</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-07T06:31:06.072483+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-07T06:52:15.208075+01:00&quot;</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;1bb246ab-7417-4cef-bddc-8fc8fc941d3a&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;modified test list&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;private&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;optin&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;single&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="nt">&quot;subscriber_count&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="p">}</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.dfff1995.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.78eede0e.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink