lumail.campaigns.delete

SDK 2.1.0 · API v2 · DELETE /api/v2/campaigns/:campaignId

MethodDELETE

/api/v2/campaigns/:campaignId

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.campaigns.delete("cmp_abc123");
if (error) {
  throw error;
}
console.log(data.deleted, data.id);

Response Examples

{
  "object": "campaign",
  "id": "cmp_abc123",
  "deleted": true
}

[email protected] · lumail.campaigns

campaigns.delete(campaignId: string): Promise<LumailResult<DeleteCampaignResponse>>

Deletes the campaign.

Path Parameters

Name	Type	Description
`campaignId`	string	Required. Campaign id.

Response Fields

Field	Type	Description
`object`	string	Resource name (`campaign`).
`id`	string	Deleted campaign id.
`deleted`	`true`	Always `true` on success.

data is { object, id, deleted: true }. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.campaigns.update Nextlumail.campaigns.send