Send Campaign

Send or schedule a campaign for delivery

MethodPOST

/api/v1/campaigns/{campaignId}/send

Request Examples

import { Lumail } from "lumail";
const lumail = new Lumail({ apiKey: "YOUR_API_TOKEN" });

// Send immediately
await lumail.campaigns.send("cmp_abc123xyz");

// Schedule for later
await lumail.campaigns.send("cmp_abc123xyz", {
  scheduledAt: "2025-03-15T14:00:00.000Z",
  timezone: "Europe/Paris",
});

Response Examples

{
  "success": true,
  "campaign": {
    "id": "cmp_abc123xyz",
    "status": "SCHEDULED",
    "scheduledAt": "2025-03-15T14:00:00.000Z",
    "timezone": "Europe/Paris",
    "campaignId": "cmp_abc123xyz"
  },
  "campaignId": "cmp_abc123xyz"
}

POST https://lumail.io/api/v1/campaigns/{campaignId}/send

Send a campaign immediately or schedule it for later delivery. Only campaigns in DRAFT status can be sent.

Response

Success (200 OK) - Campaign has been scheduled for sending.
Error (400 Bad Request) - Campaign is not in DRAFT status, missing unsubscribe link, or scheduledAt is in the past.
Error (404 Not Found) - Campaign not found or doesn't belong to your organization.
Error (401 Unauthorized) - Invalid or missing API token.

Path Parameters

Parameter	Type	Description
`campaignId`	string	Required. The unique campaign ID

Request Body

Field	Type	Default	Description
`scheduledAt`	string	—	ISO 8601 datetime for scheduled delivery. Omit to send immediately.
`timezone`	string	`"UTC"`	Timezone for scheduling (e.g., `"Europe/Paris"`, `"America/New_York"`).

Response Fields

Field	Type	Description
`success`	boolean	Indicates if the operation was successful
`campaign.id`	string	The campaign ID
`campaign.status`	string	Updated status (always `"SCHEDULED"`)
`campaign.scheduledAt`	string	The scheduled send time in ISO 8601 format
`campaign.timezone`	string	The timezone used for scheduling
`campaignId`	string	The campaign ID (convenience field)

Important Notes

Only DRAFT campaigns can be sent. Scheduled, sending, sent, or archived campaigns cannot be sent again.
Unsubscribe link required. Your campaign content must include {{unsubscribeUrl}}. The API will return an error if it's missing.
Omit scheduledAt to send immediately. The campaign will begin sending right away.
scheduledAt must be in the future. Past dates will return a 400 error.
Once sent, the campaign status transitions: DRAFT → SCHEDULED → SENDING → SENT.

Usage Example

Use this API endpoint to:

Trigger campaign sends from your own application or CRM
Schedule campaigns for optimal delivery times
Build automated campaign workflows with external tools
Integrate campaign sending into CI/CD or marketing automation pipelines

List Campaigns - List all campaigns
Create Campaign - Create a new campaign
Get Campaign - Get details for a specific campaign
Update Campaign - Update a campaign
Delete Campaign - Delete a campaign

PreviousDelete Campaign NextAPI v2