Send an opt-in confirmation email

1 parameter

idintegerrequired

The numeric identifier of the subscriber to send an opt-in confirmation email to.

1 status code

200Returns an object whose `data` field indicates whether the opt-in confirmation email was sent.

databooleanoptional

Error handling

The id path parameter must be the numeric identifier of the subscriber who should receive the opt-in confirmation email.

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.optin.create({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": true
}

Request

Response

Errors