Skip to content

listmonk / Documentation

Import

API / Import¶

Method	Endpoint	Description
GET	/api/import/subscribers	Retrieve import statistics.
GET	/api/import/subscribers/logs	Retrieve import logs.
POST	/api/import/subscribers	Upload a file for bulk subscriber import.
DELETE	/api/import/subscribers	Stop and remove an import.

GET /api/import/subscribers¶

Retrieve the status of an import.

Example Request¶

curl -u "username:username" -X GET 'http://localhost:9000/api/import/subscribers'

Example Response¶

{
    "data": {
        "name": "",
        "total": 0,
        "imported": 0,
        "status": "none"
    }
}

GET /api/import/subscribers/logs¶

Retrieve logs related to imports.

Example Request¶

curl -u "username:username" -X GET 'http://localhost:9000/api/import/subscribers/logs'

Example Response¶

{
    "data": "2020/04/08 21:55:20 processing 'import.csv'\n2020/04/08 21:55:21 imported finished\n"
}

POST /api/import/subscribers¶

Send a CSV (optionally ZIP compressed) file to import subscribers. Use a multipart form POST.

Parameters¶

Name	Type	Required	Description
params	JSON string	Yes	Stringified JSON with import parameters.
file	File	Yes	File for upload.

params (JSON string)

    {
        "mode": "subscribe", // subscribe or blocklist
        "delim": ",",        // delimiter in the uploaded file
        "lists":[1],         // array of list IDs to import into
        "overwrite": true    // overwrite existing entries or skip them?
    }

DELETE /api/import/subscribers¶

Stop and delete an ongoing import.

Example Request¶

curl -u "username:username" -X DELETE 'http://localhost:9000/api/import/subscribers'

Example Response¶

{
    "data": {
        "name": "",
        "total": 0,
        "imported": 0,
        "status": "none"
    }
}