mailerpress/create-campaign-batch initialises the send batch for a compiled campaign.
A send is a batch: MailerPress splits the recipients into chunks and hands them to Action Scheduler, which dispatches them over time. So a send is a process with a state rather than an event that happened.
At a glance
| Ability | mailerpress/create-campaign-batch |
| Toolset | MailerPress — toolset/mailerpress |
| Group | MailerPress › Campaigns & Sending |
| Requires | AcrossAI Pro, plus MailerPress active on the site |
| Capability | manage_options |
| Safety | Writes data |
| Repeatable | Not idempotent — each call changes the row set, so re-running is not a no-op |
| Ships in | AcrossAI Pro 0.9.16 and later |
This sends the campaign
This starts a real send to a real audience. Immediate means immediate: chunks begin dispatching on the next Action Scheduler tick, and contacts already emailed cannot be un-emailed. Check the audience count with mailerpress/count-campaign-audience and the artifact with mailerpress/check-campaign-send-readiness before running this.
How it works
It requires three things: the compiled HTML, the sender configuration, and the audience targeting. A campaign missing any of them cannot be batched, and the failure is at this point rather than earlier.
sendType of immediate sends right away; future schedules for scheduledAt.
Chunking is why a large send does not time out and why it is interruptible. mailerpress/pause-campaign-batch stops the chunks that have not dispatched; the ones that have are already delivered.
So a send is partially reversible at best. The practical control is before the batch, not after it.
The compiled HTML is taken as it is. A stale artifact sends stale content, which is the failure mailerpress/check-campaign-send-readiness exists to catch.
Not idempotent — each call creates another batch.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
id | integer | Yes | The campaign ID. |
sendType | string | Yes | immediate or future. |
scheduledAt | string | For future | When to send. |
lists | array | For classic targeting | List IDs. |
tags | array | For classic targeting | Tag IDs. |
segment_id | integer | For segment targeting | The segment. |
What comes back
| Name | Type | What it is |
|---|---|---|
batch_id | integer | The send batch created. |
recipients | integer | How many contacts it will reach. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
Send the campaign to the newsletter list now.
It resolves to one call:
{
"ability": "mailerpress/create-campaign-batch",
"parameters": {
"id": 44,
"sendType": "immediate",
"lists": [3]
}
}Worth knowing
- Needs compiled HTML, a sender and targeting. Missing any fails here.
- Chunks dispatch over time and cannot be recalled once sent.
- A stale artifact sends stale content.
- Not idempotent — another call is another batch.
Related abilities
- MailerPress Count Campaign Audience — check the reach first
- MailerPress Check Campaign Send Readiness — check the artifact first
- MailerPress Pause Campaign Batch — stop it mid-flight
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category