Replace campaign archive settings

1 parameter · 3 body fields

idintegerrequired

The unique integer identifier of the campaign whose archive settings you want to change.

Optional campaign archive settings.

archivebooleanoptional

Whether the campaign should be archived.

archive_template_idintegeroptional

The integer identifier of the template to use for the archive.

archive_metaobjectoptional

Additional archive metadata.

1 status code

200Returns a boolean indicating the result of the archive settings update.

databooleanoptional

Error handling

The id path parameter must identify the campaign whose archive settings you want to replace. The request body fields are optional and have no additional schema constraints.

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.archive.update({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  archive: true,
  archiveTemplateId: 1559,
  archiveMeta: {},
});

{
  "data": true
}

Request

Response

Errors