lumail.campaigns.send

SDK 2.1.0 · API v2 · POST /api/v2/campaigns/:campaignId/send

MethodPOST

/api/v2/campaigns/:campaignId/send

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.campaigns.send("cmp_abc123", {
  scheduledAt: "2026-06-01T09:00:00Z",
  timezone: "Europe/Paris",
});
if (error) {
  throw error;
}
console.log(data.status, data.scheduledAt);

Response Examples

{
  "id": "cmp_abc123",
  "status": "SCHEDULED",
  "scheduledAt": "2026-06-01T09:00:00.000Z",
  "timezone": "Europe/Paris"
}

[email protected] · lumail.campaigns

campaigns.send(campaignId: string, params?: SendCampaignParams): Promise<LumailResult<SendCampaignResponse>>

No date sends immediately. Optional scheduledAt and timezone. The SDK sends {} when params is omitted.

Path Parameters

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

Body Parameters

Name	Type	Description
`scheduledAt`	string	ISO 8601 datetime. Omit to send immediately. Must be in the future.
`timezone`	string	IANA timezone for the schedule.

Response Fields

Field	Type	Description
`id`	string	Campaign id.
`campaignId`	string	Optional alias of `id`.
`status`	`"SCHEDULED"` / `"SENDING"` / string	New status.
`scheduledAt`	string	Scheduled time when set.
`timezone`	string	Timezone when set.

data is the send result. Failures return { data: null, error: { name, message, statusCode } }.

Previouslumail.campaigns.delete Nextlumail.tags