Delete Campaign

Delete a campaign.

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
}

Deletes a campaign. Permission: campaigns.

Path Parameters

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

Response Fields

Field	Type	Description
`object`	`"campaign"`	Discriminator.
`id`	string	Deleted campaign id.
`deleted`	`true`	Always `true` on success.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `campaigns` permission
404	`not_found`	Unknown campaign id

List Campaigns
SDK: lumail.campaigns.delete

PreviousUpdate Campaign NextSend Campaign

Path Parameters

Response Fields

Errors

Related