mirror of
https://github.com/knadh/listmonk.git
synced 2025-09-13 09:54:37 +08:00
2096 lines
No EOL
54 KiB
HTML
2096 lines
No EOL
54 KiB
HTML
|
|
<!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.6.1, mkdocs-material-9.6.18">
|
|
|
|
|
|
|
|
<title>Lists - listmonk / Documentation</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.7e37652d.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-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 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></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">
|
|
|
|
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.52 6.52 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 5"/></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.52 6.52 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 5"/></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 11z"/></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 12z"/></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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../roles-and-permissions/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
User roles and permissions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../oidc/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OIDC SSO
|
|
|
|
</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 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">
|
|
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">
|
|
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">
|
|
<span class="md-ellipsis">
|
|
GET /api/lists
|
|
</span>
|
|
</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">
|
|
<span class="md-ellipsis">
|
|
Parameters
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<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="#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-apipubliclists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
GET /api/public/lists
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GET /api/public/lists">
|
|
<ul class="md-nav__list">
|
|
|
|
<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-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
GET /api/lists/{list_id}
|
|
</span>
|
|
</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">
|
|
<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="#post-apilists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
POST /api/lists
|
|
</span>
|
|
</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">
|
|
<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="#put-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
PUT /api/lists/{list_id}
|
|
</span>
|
|
</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">
|
|
<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="#delete-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
DELETE /api/lists/{list_id}
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="DELETE /api/lists/{list_id}">
|
|
<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_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>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</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">
|
|
<a href="../campaigns/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Campaigns
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</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-apilists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
GET /api/lists
|
|
</span>
|
|
</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">
|
|
<span class="md-ellipsis">
|
|
Parameters
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<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="#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-apipubliclists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
GET /api/public/lists
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GET /api/public/lists">
|
|
<ul class="md-nav__list">
|
|
|
|
<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-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
GET /api/lists/{list_id}
|
|
</span>
|
|
</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">
|
|
<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="#post-apilists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
POST /api/lists
|
|
</span>
|
|
</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">
|
|
<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="#put-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
PUT /api/lists/{list_id}
|
|
</span>
|
|
</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">
|
|
<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="#delete-apilistslist_id" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
DELETE /api/lists/{list_id}
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="DELETE /api/lists/{list_id}">
|
|
<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_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>
|
|
|
|
</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">¶</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-apilists">/api/lists</a></td>
|
|
<td style="text-align: left;">Retrieve all lists.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">GET</td>
|
|
<td style="text-align: left;"><a href="#get-public-apilists">/api/public/lists</a></td>
|
|
<td style="text-align: left;">Retrieve public lists.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">GET</td>
|
|
<td style="text-align: left;"><a href="#get-apilistslist_id">/api/lists/{list_id}</a></td>
|
|
<td style="text-align: left;">Retrieve a specific list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">POST</td>
|
|
<td style="text-align: left;"><a href="#post-apilists">/api/lists</a></td>
|
|
<td style="text-align: left;">Create a new list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">PUT</td>
|
|
<td style="text-align: left;"><a href="#put-apilistslist_id">/api/lists/{list_id}</a></td>
|
|
<td style="text-align: left;">Update a list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">DELETE</td>
|
|
<td style="text-align: left;"><a href="#delete-apilistslist_id">/api/lists/{list_id}</a></td>
|
|
<td style="text-align: left;">Delete a list.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr />
|
|
<h4 id="get-apilists">GET /api/lists<a class="headerlink" href="#get-apilists" title="Permanent link">¶</a></h4>
|
|
<p>Retrieve lists.</p>
|
|
<h5 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">¶</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;">query</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">string for list name search.</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 lists. Repeat in the query for multiple values.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">tag</td>
|
|
<td style="text-align: left;">[]string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">Tags to filter lists. Repeat in the query for multiple values.</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;">Sort field. Options: name, status, created_at, updated_at.</td>
|
|
</tr>
|
|
<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. Options: ASC, DESC.</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 pagination.</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 to 'all' to return all results.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="example-request">Example Request<a class="headerlink" href="#example-request" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">"api_user:token"</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">'http://localhost:9000/api/lists?page=1&per_page=100'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response">Example Response<a class="headerlink" href="#example-response" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"results"</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">"id"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-02-10T23:07:16.194843+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-06T22:32:01.118327+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ce13e971-c2ed-4069-bd0c-240e9a9f56f9"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Default list"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"optin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"double"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
|
|
<span class="w"> </span><span class="s2">"test"</span>
|
|
<span class="w"> </span><span class="p">],</span>
|
|
<span class="w"> </span><span class="nt">"subscriber_count"</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">"id"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-04T21:12:09.555013+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-06T22:34:46.405031+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f20a2308-dfb5-4420-a56d-ecf0618a102d"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"get"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"private"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"optin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"single"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
<span class="w"> </span><span class="nt">"subscriber_count"</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">"total"</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">"per_page"</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">"page"</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-apipubliclists">GET /api/public/lists<a class="headerlink" href="#get-apipubliclists" title="Permanent link">¶</a></h4>
|
|
<p>Retrieve public lists with name and uuid to submit a subscription. This is an unauthenticated call to enable scripting to subscription form.</p>
|
|
<h5 id="example-request_1">Example Request<a class="headerlink" href="#example-request_1" title="Permanent link">¶</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">'http://localhost:9000/api/public/lists'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response_1">Example Response<a class="headerlink" href="#example-response_1" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">[</span>
|
|
<span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"55e243af-80c6-4169-8d7f-bc571e0269e9"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Opt-in list"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="p">]</span>
|
|
</code></pre></div>
|
|
<hr />
|
|
<h4 id="get-apilistslist_id">GET /api/lists/{list_id}<a class="headerlink" href="#get-apilistslist_id" title="Permanent link">¶</a></h4>
|
|
<p>Retrieve a specific list.</p>
|
|
<h5 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">¶</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;">list_id</td>
|
|
<td style="text-align: left;">number</td>
|
|
<td style="text-align: left;">Yes</td>
|
|
<td style="text-align: left;">ID of the list to retrieve.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="example-request_2">Example Request<a class="headerlink" href="#example-request_2" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">"api_user:token"</span><span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s1">'http://localhost:9000/api/lists/5'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response_2">Example Response<a class="headerlink" href="#example-response_2" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"id"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:31:06.072483+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:31:06.072483+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1bb246ab-7417-4cef-bddc-8fc8fc941d3a"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test list"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"optin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"double"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
<span class="w"> </span><span class="nt">"subscriber_count"</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>
|
|
<hr />
|
|
<h4 id="post-apilists">POST /api/lists<a class="headerlink" href="#post-apilists" title="Permanent link">¶</a></h4>
|
|
<p>Create a new list.</p>
|
|
<h5 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">¶</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;">Name of the new list.</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;">Type of list. Options: private, public.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">optin</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;">Yes</td>
|
|
<td style="text-align: left;">Opt-in type. Options: single, double.</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;">Associated tags for a list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">description</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;">No</td>
|
|
<td style="text-align: left;">Description of the new list.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="example-request_3">Example Request<a class="headerlink" href="#example-request_3" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">"api_user:token"</span><span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s1">'http://localhost:9000/api/lists'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response_3">Example Response<a class="headerlink" href="#example-response_3" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"id"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:31:06.072483+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:31:06.072483+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1bb246ab-7417-4cef-bddc-8fc8fc941d3a"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Test list"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"public"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
<span class="w"> </span><span class="nt">"subscriber_count"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This is a test list"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="kc">null</span>
|
|
</code></pre></div>
|
|
<hr />
|
|
<h4 id="put-apilistslist_id">PUT /api/lists/{list_id}<a class="headerlink" href="#put-apilistslist_id" title="Permanent link">¶</a></h4>
|
|
<p>Update a list.</p>
|
|
<h5 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">¶</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;">list_id</td>
|
|
<td style="text-align: left;">number</td>
|
|
<td style="text-align: left;">Yes</td>
|
|
<td style="text-align: left;">ID of the list to update.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">name</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">New name for the list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">type</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">Type of list. Options: private, public.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">optin</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">Opt-in type. Options: single, double.</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;">Associated tags for the list.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left;">description</td>
|
|
<td style="text-align: left;">string</td>
|
|
<td style="text-align: left;"></td>
|
|
<td style="text-align: left;">Description of the new list.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="example-request_4">Example Request<a class="headerlink" href="#example-request_4" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s2">"api_user:token"</span><span class="w"> </span>-X<span class="w"> </span>PUT<span class="w"> </span><span class="s1">'http://localhost:9000/api/lists/5'</span><span class="w"> </span><span class="se">\</span>
|
|
--form<span class="w"> </span><span class="s1">'name=modified test list'</span><span class="w"> </span><span class="se">\</span>
|
|
--form<span class="w"> </span><span class="s1">'type=private'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response_4">Example Response<a class="headerlink" href="#example-response_4" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"id"</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">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:31:06.072483+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2020-03-07T06:52:15.208075+01:00"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"uuid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1bb246ab-7417-4cef-bddc-8fc8fc941d3a"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"modified test list"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"private"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"optin"</span><span class="p">:</span><span class="w"> </span><span class="s2">"single"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="nt">"tags"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span>
|
|
<span class="w"> </span><span class="nt">"subscriber_count"</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">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"This is a test list"</span>
|
|
<span class="w"> </span><span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</code></pre></div>
|
|
<hr />
|
|
<h4 id="delete-apilistslist_id">DELETE /api/lists/{list_id}<a class="headerlink" href="#delete-apilistslist_id" title="Permanent link">¶</a></h4>
|
|
<p>Delete a specific list.</p>
|
|
<h5 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">¶</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;">list_id</td>
|
|
<td style="text-align: left;">Number</td>
|
|
<td style="text-align: left;">Yes</td>
|
|
<td style="text-align: left;">ID of the list to delete.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="example-request_5">Example Request<a class="headerlink" href="#example-request_5" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-u<span class="w"> </span><span class="s1">'api_username:access_token'</span><span class="w"> </span>-X<span class="w"> </span>DELETE<span class="w"> </span><span class="s1">'http://localhost:9000/api/lists/1'</span>
|
|
</code></pre></div>
|
|
<h5 id="example-response_5">Example Response<a class="headerlink" href="#example-response_5" title="Permanent link">¶</a></h5>
|
|
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
|
<span class="w"> </span><span class="nt">"data"</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.973d3a69.min.js", "tags": null, "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"}, "version": null}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |