Submit a public subscription request

3 body fields

Optional subscription request parameters.

namestringoptional

The subscriber's name.

emailstringoptional

The subscriber's email address.

list_uuidsarray<string>optional

An array of list UUIDs associated with the subscription request.

1 status code

200Returns an object with `has_optin`, indicating whether opt-in is required.

has_optinbooleanoptional

Error handling

The request body is optional, and none of its fields are required. If supplied, name and email must be strings, and list_uuids must be an array of strings.

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.subscription.create({
  name: "Untitled",
  email: "jane.doe@example.com",
  listUuids: [],
});

{
  "has_optin": true
}

Request

Response

Errors