Import subscribers from a ZIP file

2 body fields

Multipart form data for uploading a ZIP archive of CSV files and optional import parameters.

paramsstringoptional

JSON string containing import parameters for more detail https://listmonk.app/docs/apis/import/#params-json-string

filestringoptional

File for upload.

1 status code

200Returns the updated subscriber import status.

dataobjectoptional

Error handling

Send the upload using multipart/form-data, with the ZIP file in file; the archive should contain one or more CSV files. If you provide params, it must be a JSON string containing import parameters.

import { Client } from "listmonk-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:9000/api",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
});

const result = await client.subscribers.create({
  params: "example",
  file: "example",
});

{
  "data": {
    "data": {
      "name": "Example Name",
      "total": 42,
      "imported": 1,
      "status": "active"
    }
  }
}

Request

Response

Errors