beenull/listmonk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Expanded docs about PUT /api/subscribers/:id (#1269)

Browse source 
I've expanded the docs a bit, related to #995
This commit is contained in:
Marcin Kunert 2023-04-02 17:10:38 +02:00 committed by GitHub
parent b433ef68ec
commit ad53632be4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/content/apis/subscribers.md
View file

@ -9,7 +9,7 @@ Method | Endpoint
`GET` | [/api/subscribers](#get-apisubscribers_1) | Gets subscribers filtered by an arbitrary SQL expression. `GET` | [/api/subscribers](#get-apisubscribers_1) | Gets subscribers filtered by an arbitrary SQL expression.
`POST` | [/api/subscribers](#post-apisubscribers) | Creates a new subscriber. `POST` | [/api/subscribers](#post-apisubscribers) | Creates a new subscriber.
`PUT` | [/api/subscribers/lists](#put-apisubscriberslists) | Modify subscribers' list memberships. `PUT` | [/api/subscribers/lists](#put-apisubscriberslists) | Modify subscribers' list memberships.
`PUT` | /api/subscribers/:`id` | Updates a subscriber by ID. `PUT` | [/api/subscribers/:`id`](#put-apisubscribersid) | Updates a subscriber by ID.
`PUT` | [/api/subscribers/:`id`/blocklist](#put-apisubscribersidblocklist) | Blocklists a single subscriber. `PUT` | [/api/subscribers/:`id`/blocklist](#put-apisubscribersidblocklist) | Blocklists a single subscriber.
`PUT` | /api/subscribers/blocklist | Blocklists one or more subscribers. `PUT` | /api/subscribers/blocklist | Blocklists one or more subscribers.
`PUT` | [/api/subscribers/query/blocklist](#put-apisubscribersqueryblocklist) | Blocklists subscribers with an arbitrary SQL expression. `PUT` | [/api/subscribers/query/blocklist](#put-apisubscribersqueryblocklist) | Blocklists subscribers with an arbitrary SQL expression.
@ -349,6 +349,15 @@ curl -u "username:username" -X PUT 'http://localhost:9000/api/subscribers/lists'
} }
``` ```
#### **`PUT`** /api/subscribers/:`id`
Updates a single subscriber.
##### Parameters
Parameters are the same as [POST /api/subscribers](#post-apisubscribers) used for subscriber creation.
> Please note that this is a `PUT` request, so all the parameters have to be set. For example if you don't provide `lists`, the subscriber will be deleted from all the lists he was previously signed on.
#### **`PUT`** /api/subscribers/:`id`/blocklist #### **`PUT`** /api/subscribers/:`id`/blocklist
Blocklists a single subscriber. Blocklists a single subscriber.