lumail.campaigns.update

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

MethodPATCH

/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.update("cmp_abc123", {
  subject: "Updated subject",
});
if (error) {
  throw error;
}
console.log(data.subject);

Response Examples

{
  "id": "cmp_abc123",
  "name": "Launch",
  "subject": "Updated subject",
  "preview": null,
  "status": "DRAFT",
  "contentType": "MAILY",
  "senderId": "snd_abc123",
  "replyTo": null,
  "updatedFields": ["subject"]
}

[email protected] · lumail.campaigns

campaigns.update(campaignId: string, params: UpdateCampaignParams): Promise<LumailResult<UpdateCampaignResponse>>

Patch a draft. Locked on SCHEDULED, SENDING, SENT, and workflow campaigns.

Path Parameters

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

Body Parameters

Name	Type	Description
`subject`	string	Subject line.
`name`	string	Internal name.
`preview`	string or null	Preview / preheader text.
`content`	unknown	Campaign body.
`contentType`	`"MAILY"` / `"PLATE"` / `"MARKDOWN"`	Editor format.
`senderId`	string	Sending identity id.
`replyTo`	string or null	Reply-To address.

Response Fields

All body fields are optional (Partial<CreateCampaignParams>).

Field	Type	Description
`id`	string	Campaign id.
`name`	string	Internal name.
`subject`	string	Subject line.
`preview`	string or null	Preview text.
`status`	`CampaignStatus`	Current status.
`contentType`	`ContentType`	Editor format.
`senderId`	string	Sending identity id.
`replyTo`	string or null	Reply-To address.
`updatedFields`	string[]	Fields that changed.
`warnings`	string[]	Optional non-fatal notes.

data is the patched campaign. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.campaigns.get Nextlumail.campaigns.delete