knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2024-12-26 00:42:58 +08:00
Code Issues Projects Releases Packages Wiki Activity

Add curl example to subscriber import docs.

Browse source
This commit is contained in:
Kailash Nadh 2024-11-15 12:02:09 +05:30
parent 1198f6f3af
commit 392bc87225
1 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/docs/content/apis/import.md
View file

@ -11,7 +11,7 @@ ______________________________________________________________________
#### GET /api/import/subscribers
Retrieve the status of an import.
Retrieve the status of an ongoing import.
##### Example Request
@ -36,7 +36,7 @@ ______________________________________________________________________
#### GET /api/import/subscribers/logs
Retrieve logs related to imports.
Retrieve logs from an ongoing import.
##### Example Request
@ -63,9 +63,26 @@ Send a CSV (optionally ZIP compressed) file to import subscribers. Use a multipa
| Name | Type | Required | Description |
|:-------|:------------|:---------|:-----------------------------------------|
| params | JSON string | Yes | Stringified JSON with import parameters. |
| file | File | Yes | File for upload. |
| file | file | Yes | File for upload. |
**`params`** (JSON string)
#### `params` (JSON string)
| Name | Type | Required | Description |
|:----------|:---------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------|
| mode | string | Yes | `subscribe` or `blocklist` |
| delim | string | Yes | Single character indicating delimiter used in the CSV file, eg: `,` |
| lists | []number | Yes | Single character indicating delimiter used in the CSV file, eg: `,` |
| overwrite | bool | Yes | Whether to overwrite the subscriber parameters including subscriptions or ignore records that are already present in the database. |
##### Example Request
```shell
curl -u "username:password" -X POST 'http://localhost:9000/api/import/subscribers' \
-F 'params={"mode":"subscribe", "subscription_status":"confirmed", "delim":",", "lists":[1, 2], "overwrite": true}' \
-F "file=@/path/to/subs.csv"
```
##### Example Response
```json
{